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.
Pages de cette section
-
Assertions pour la surveillance multi-étapeComprendre les assertions dans la surveillance multi-étape.
-
Authentification lors de la surveillance multi-étapesDécouvrez les options disponibles pour l’authentification lors de l’utilisation de la surveillance API multi-étapes.
-
Configuration d'un moniteur API multi-étapesInstructions pas-à-pas pour configurer un moniteur API multi-étapes
-
Configuration des métriques personnaliséesCet article décrit comment vous pouvez utiliser la fonctionnalité Custom Metrics (métriques personnalisées) pour capturer des données API. Il peut s’agir de l’API d’un partenaire technique que vous utilisez pour votre entreprise ou de votre propre API que vous avez créée pour le support de vos propres clients ou processus. Il peut même s’agir d’une API personnalisée que vous avez créée pour collecter ou exploiter des données commerciales internes ou d’une plate-forme.
-
Exemples XPath de Monitoring multi-étapeCet article montre plusieurs exemples d’extraction de contenu à partir de réponses XML à l’aide de XPath. Ces requêtes XPath vous permettent d’inspecter une réponse XML provenant de votre API ou de votre service Web dans le cadre d’un Moniteur API multi-étapes. Une requête XPath définit la partie de la réponse XML qui vous intéresse, généralement une valeur contenue dans l’un des nœuds XML. Vous pouvez alors prendre cette valeur extraite et vérifier si elle satisfait à certaines conditions (en utilisant des assertions), ou la stocker dans une variable pour une utilisation ultérieure.
-
Fonctions définies par l'utilisateurCet article présente les fonctions définies par l’utilisateur et leur utilisation
-
Informations sur les clés publiques des certificats client d'UptrendsUtiliser les clés publiques d’Uptrends avec vos API Monitor multi-étapes afin de s’assurer que les requêtes proviennent d’Uptrends.
-
Les certificats clients dans le Monitoring multi-étapesUtilisation de certificats clients avec la surveillance API multi-étapes
-
Mise en place SOAPVous cherchez à ajouter un moniteur SOAP à votre compte Uptrends ? C’est une bonne nouvelle. Notre Académie propose un cours pratique sur l’ajout de moniteurs, mais si vous cherchez une approche plus spécifique à SOAP, vous êtes au bon endroit. Mise en place d’un moniteur de service web SOAP Pour tester un service SOAP, on appelle en général une méthode de ce service web avec des données d’entrée sous la forme d’une enveloppe SOAP, puis on vérifie que la réponse est correcte.
-
Multi-step monitoringDécouvrez comment utiliser les redirections dans vos moniteurs API multi-étapes.
-
Multi-step monitoring opérateurs de comparaisonDécouvrez les opérateurs de comparaison disponibles lors de la configuration de la surveillance API multi-étapes.
-
Multi-step monitoring variablesComment utiliser les variables pour stocker les valeurs extraites des réponses API et les utiliser ultérieurement.
-
Portail pour les moniteurs API multi-étapesVotre point de départ pour explorer la surveillance des API
-
Sources possibles pour la surveillance multi-étapesComment extraire des valeurs pour créer des assertions ou affecter des variables lors de la configuration d’une surveillance d’API multi-étapes.
-
Surveillance de services WebSurveillance de services Web avec Uptrends : découvrez quels services sont pris en charge et comment ils fonctionnent.
-
Valeurs de hachage et d'encodageDans certains cas d’usage de la surveillance des API, il peut être nécessaire de hacher ou d’encoder des variables ou des valeurs. Par exemple, la configuration des autorisations peut nécessiter un encodage en base64 ou un hachage avec la fonction HMAC-SHA-256 pour pouvoir travailler efficacement. Vous pouvez aussi avoir besoin d’inclure du contenu encodé au format JSON dans votre corps de requête. C’est pour cette raison qu’Uptrends propose plusieurs options d’encodage et de hachage, que nous vous présentons dans cet article.
-
Éditeur de script pour les API multi-étapesUne présentation de l’éditeur de script pour les API multi-étapes