Le moniteur d’API multi-étapes est composé d' étapes. Pour chaque étape, vous pouvez configurer les détails de la requête et de la réponse HTTP. Cet article vous fournit une vue d’ensemble du fonctionnement des réponses d’API dans un moniteur d’API multi-étapes. Vous y découvrirez quelles définitions de réponse HTTP sont disponibles et comment les configurer.
Réponse
Chaque étape contient l’onglet Réponse. Dans cet onglet, vous pouvez configurer des vérifications et des validations concernant le comportement de la réponse d’API.
Assertions
Les assertions sont des conditions spécifiques que vous pouvez définir pour valider la réponse d’API. L’assertion vérifie si l’API renvoie les données, les codes de statut, les en-têtes, les délais de réponse et les autres éléments attendus.
Pour chaque étape, vous pouvez définir un nombre d’assertions basé sur vos besoins de surveillance. Pour définir une assertion, vous avez besoin des éléments suivants :
- Source de l’assertion
- Propriété de l’assertion
- Comparaison de l’assertion
- Valeur cible de l’assertion
Pour en savoir plus, vous pouvez lire notre article Utilisation d’assertions dans les moniteurs d’API multi-étapes.
Variables
Lors de la configuration de scénarios d’API multi-étapes, vous pouvez devoir extraire des données issues des étapes précédentes afin de les utiliser à des étapes ultérieures. Par exemple, dans la première étape, votre API exécute une requête GET pour récupérer un ID. À la deuxième étape, vous devez utiliser le même ID en tant que paramètre de requête d’un appel d’API.
Dans de telles situations, les variables vous permettent d’extraire des valeurs de réponses HTTP et de les stocker afin de les réutiliser dans le scénario d’API. En capturant cette valeur, en la stockant temporairement et en la transmettant aux étapes suivantes, vous créez une progression naturelle d’étapes interconnectées, sans avoir besoin d’écrire de code.
Pour chaque étape, vous pouvez créer des variables. Celles-ci peuvent être des valeurs extraites de données JSON ou XML, d’en-têtes de réponse, de données provenant d’une
redirection, et plus encore. Une fois la variable définie, vous pouvez l’utiliser dans votre configuration multi-étapes en utilisant la syntaxe {{my-variable}}.
Pour en savoir plus, vous pouvez lire notre article Variables pour les moniteurs d’API multi-étapes.
Nombre maximal de tentatives
Dans certains cas, une requête API peut nécessiter plus de temps pour que le processus s’exécute jusqu’à renvoyer une réponse satisfaisante. Par exemple, c’est le cas lorsqu’un délai est nécessaire pour charger un fichier, pour exécuter un paiement ou pour recevoir un e-mail de vérification. C’est aussi le cas lorsqu’une requête d’API ou une assertion échoue en raison d’un problème externe comme une mauvaise connexion réseau ou une panne inattendue. Dans ces situations, vous pouvez configurer un nombre maximal de tentatives pour réexécuter automatiquement la même étape.
En reproduisant la même étape, vous indiquez au moniteur que l’étape est en attente et doit être revérifiée, et non pas traitée comme une erreur. Cela vous aide aussi à mesurer le temps nécessaire à l’exécution du processus de fond.
Vous pouvez configurer entre 2 et 50 tentatives et préciser le délai en millisecondes entre chaque tentative. Pour en savoir plus, vous pouvez lire notre article Nombre maximal de tentatives.
Personnalisation de scripts
La requête et la réponse d’une étape peuvent toutes deux être enrichies en personnalisant les scripts dans les onglets Pré-Requête et Post-Réponse. Cette fonctionnalité vous permet d’exécuter des scripts écrits en langage JavaScript pour exécuter une logique personnalisée et des tests fonctionnels approfondis. En plus des capacités offertes par le langage JavaScript, vous pouvez aussi utiliser les extraits de code, qui sont des scripts prédéfinis fournis par Uptrends pour vous permettre de vérifier le fonctionnement et le comportement de vos API.