Les moniteurs d'API Uptrends peuvent vérifier une réponse unique ou gérer des appels d'API complexes en plusieurs étapes. Dans cette leçon, nous allons expliquer les bases de la configuration d’un moniteur API.

Quels types de moniteurs d'API y a-t-il ?

  • Webservice HTTP/HTTPS
    Les moniteurs HTTP/HTTPS Webservice peuvent tester une seule réponse. Nous vous recommandons d'utiliser les moniteurs Webservice pour vérifier la disponibilité d'une API à l'aide des vérifications de l'authentification et du contenu. Vous trouverez plus d'informations sur les Moniteurs Webservice dans notre Base de Connaissances.
    Remarque : Regardez la leçon sur les Moniteurs de disponibilité pour savoir comment configurer les moniteurs Webservice ou consulter notre Base de Connaissances pour obtenir des informations détaillées sur les Moniteurs Webservice.
  • API multi-étapes
    Si vous devez gérer les redirections, gérer l'authentification, faire plusieurs appels API, ou réutiliser les valeurs dans un appel API, alors il vous faut utiliser un moniteur API multi-étapes. Dans ce qui suit nous vous donnerons les informations pour une configuration de base, mais vous trouverez des informations de configuration plus détaillées dans notre Base de Connaissances.

Créer un moniteur API multi-étapes

Gardez votre documentation API à portée de main pendant le processus d'installation, elle sera utile.

  1. Cliquez sur le bouton + Ajouter un moniteur  dans le menu Moniteurs  pour ouvrir l'écran de configuration Nouveau moniteur.
  2. Pour le Type, sélectionnez API multi-étapes.
  3. Donnez un Nom à votre moniteur.
  4. Choisissez la Fréquence de Vérification.
  5. Allez à l'onglet Étapes.

Arrêtons-nous un instant sur la définition d'une étape.

Qu'est-ce qu'une étape ?

Lors du monitoring multi-étape API, une étape est un appel aller-retour à l'API (une requête et une réponse). Dans chaque étape, vous pouvez définir votre requête et indiquer à Uptrends comment gérer la réponse. Chaque scénario API multi-étapes commence par une étape vide. Mettons-y quelque chose !

Configuration d'une requête

Lorsque vous êtes sur l'onglet Étapes de votre moniteur API multi-étapes, vous voyez une étape dans la colonne Étapes, mais les cases Requête et Réponse (à droite) sont tous les deux vides. On va les renseigner.

Par défaut la colonne de droite affiche d'abord la Requête.

  1. Choisissez votre Méthode HTTP et ajoutez l'URL. La méthode par défaut est GET, mais si vous choisissez POST, PUT, ou Delete, un champ de texte apparaît où vous pouvez saisir votre corps de requête.
  2. Cliquez sur Ajouter un request header pour définir la clé et la valeur de l'en-tête de votre requête ( en savoir plus).
    Les en-têtes contiennent typiquement des paires nom/valeur :

    - Accept appairé avec application/json ou text/xml, ou application/x-ww-form-urlencoded

    - Content-Type avec application/json ou text/xml, ou application/x-ww-form-urlencoded

    - Authorization avec les données pertinentes dans le champ Value.
    Remarque : Si vous devez utiliser la même valeur plusieurs fois, vous pouvez l'ajouter dans la section des variables prédéfinies vers le bas de l'écran. Vous trouverez plus d'informations sur les variables prédéfinies dans la Base de Connaissances.
  3. Configurez les options pour les champs Authentification et Certificat client, puis cochez Ignorer les erreurs de certificat TLS/SSL si vous ne voulez pas recevoir de notifications sur ces types d’erreurs et enfin donnez une Description de l'étape.

Traitement de la réponse

Une fois la requête envoyée, nous avons besoin de savoir comment traiter la réponse. Voyons maintenant vos options pour le traitement d'une réponse.

  1. Cliquez sur Réponse en haut de l'écran.
  2. Cliquez sur Ajouter une assertion (en savoir plus).
  3. Choisissez le type de réponse dans la première case. Uptrends utilise votre choix ici pour configurer les autres champs d'assertion. Allez-y et explorez tous les différents types de réponses disponibles. Pour votre première assertion, essayez de vérifier le Code de statut. Vous aurez deux cases supplémentaires à compléter.
  4. Définissez l'opérateur de comparaison. Nous voulons nous assurer que la requête a réussi, alors choisissons "Est égal à ."
  5. Mettez la valeur que vous attendez dans la dernière case. Dans ce cas, nous voulons nous assurer que la requête a réussi, donc mettons "200".

  6. Continuez à ajouter des assertions, autant que nécessaires.
  7. Ajoutez des variables pour les valeurs que vous devez réutiliser en cliquant sur le bouton Ajouter une variable. Définissez le type de réponse, ajoutez la requête ou l'expression et donnez un nom à votre variable (apprenez comment définir et utiliser les variables).
  8. Cliquez sur Enregistrer si votre moniteur doit uniquement effectuer une seule requête, sinon vous pouvez continuer à ajouter des étapes à l'aide du bouton + Ajouter une étape  dans la colonne de gauche.
Remarque: Nous avons des instructions détaillées et des exemples dans la section Monitoring API de la Base de Connaissances.