Une API (Application Programming Interface ou « interface de programmation d’application ») est un logiciel qui permet à plusieurs applications de communiquer entre elles. Vous pouvez utiliser vos propres API ou des API tierces. Dans les deux cas, les API doivent être surveillées, car elles sont indispensables au bon fonctionnement de votre site web et de vos services.
La fonction de monitoring d’API vérifie si les API que vous utilisez sont disponibles, en bon état de fonctionnement et performantes. Pour en savoir plus, reportez-vous à l’article Qu’est-ce que le monitoring d’API ?.
Le monitoring d’API d’Uptrends vous permet de surveiller vos API au moyen de différents types de moniteurs. Votre choix dépendra du nombre d’étapes à traiter. En cas d’étape unique, vous utiliserez le moniteur Webservice HTTP ou HTTPS. Pour surveiller une série d’étapes, vous utiliserez le moniteur Multi-step API (aussi parfois désigné sous l’acronyme MSA).
Dans l’application Uptrends, le Portail pour les moniteurs Multi-step API contient toutes les informations concernant ces moniteurs et leur statut actuel.
Configurer les moniteurs d’API
La méthode de configuration des différents types de moniteurs est décrite dans ces articles :
- Configurer un monitoring Webservice
- Configurer un monitoring Webservice (SOAP)
- Configurer un monitoring Multi-step API
Définir les étapes du moniteur Multi-step API
Lors de la configuration d’un moniteur Multi-step API, vous devez définir les étapes contenant les requêtes HTTP du scénario que vous souhaitez surveiller. Pour chaque étape, vous devez définir les détails de la requête et de la réponse. Il vous est aussi demandé de préciser des fonctions définies par l’utilisateur, des variables et des métriques. Cette configuration s’applique à toutes les étapes. Pour en savoir plus sur la configuration des étapes HTTP, lisez les articles dans les sections ci-dessous.
Requête
Pour configurer la requête étapes HTTP, vous devez préciser une méthode, une URL et la requête body, puis d’autres détails comme l’authentification. Pour en savoir plus, référez-vous aux articles ci-dessous.
- Authentification
- Certificats clients
- Certificat client d’Uptrends
- Téléchargement de fichiers pour un moniteur Multi-step API
Réponse
Dans la réponse de l’étape, vous devez définir des assertions. Les assertions sont des vérifications qui permettent de passer à l’étape suivante si la requête produit une réponse. L’assertion vérifie également si la réponse est valide et si elle est reçue dans les délais impartis. Pour chaque étape, vous pouvez définir plusieurs assertions. Pour en savoir plus sur les assertions, référez-vous à ces articles :
- Assertions - Introduction
- Assertions - Sources
- Assertions - Opérateurs de comparaison
- Assertions - Exemples utilisant XPath
- Variables
- Gestion des redirections
Définitions générales
Certaines de vos définitions peuvent s’appliquer à toutes les étapes, requête et réponse incluses. Cette possibilité s’avère très utile si vous souhaitez réutiliser une certaine valeur ou fonction pour différentes étapes. Pour en savoir plus, consultez les articles suivants :
- Variables prédéfinies
- Fonctions définies par l’utilisateur
- Métriques personnalisées
- Hachage et encodage
Éditeur de scripts
Vous pouvez aussi modifier les définitions des étapes du moniteur Multi-step API directement dans l’éditeur de scripts. Pour en savoir plus, consultez notre article sur l'éditeur de scripts MSA.