Superviser une API avec étapes et variables
Construisez une supervision composée d'une API avec authentification du coffre-fort, plusieurs étapes qui se transmettent des variables, des validations JSON et des métriques propres.
Sur cette page
Une supervision d'API exécute une ou plusieurs requêtes dans l'ordre, comme le ferait votre système : elle se connecte, capture une donnée de la réponse, l'utilise dans la requête suivante et valide chaque résultat. Elle peut tracer des valeurs numériques des réponses et alerter selon des seuils.
Avant de commencer
Vous devez avoir l'autorisation d'opérer dans Applications.
Les jetons, clés et certificats sont conservés dans le coffre-fort. Un administrateur les crée dans Paramètres → Supervision → Identifiants.
Étape 1 : données générales
Allez dans Applications → WebServices et appuyez sur Ajouter un WebService (ou sur Modifier pour un service existant).
Saisissez le Nom et, si vous le souhaitez, choisissez le Groupe (facultatif).
Le formulaire comporte les onglets Requête, Authentification, Validations, Étapes, Métriques et Où il s'exécute. Quand il y a plus d'une étape, dans Requête et Validations, vous choisissez en haut à quelle étape correspond ce que vous modifiez.
Étape 2 : la requête
Dans Requête :
Choisissez la Méthode et saisissez l'URL.
Ajoutez des Paramètres et des En-têtes avec Ajouter un paramètre et Ajouter un en-tête.
Pour les méthodes avec corps, choisissez le Type de Corps : Sans corps, JSON, Formulaire ou Texte. Si le JSON n'est pas valide, le formulaire vous avertit.
Dans Options, ajustez le Délai (s) (1 à 60), Suivre les redirections et Vérifier le certificat TLS.
Vérifiez l'Aperçu de la requête.
Ne mettez ni jetons ni clés dans les en-têtes ni dans les paramètres : utilisez l'onglet Authentification. Une méthode qui modifie des données (POST, PUT, PATCH, DELETE) s'exécute à chaque contrôle ; une confirmation est demandée à l'enregistrement.
Étape 3 : l'authentification (connexion, jeton ou OAuth2)
Dans Authentification :
Dans Identifiant, choisissez-en un du coffre-fort. Il peut s'agir de :
Un jeton d'API (dans un en-tête ou un paramètre, avec préfixe).
Un utilisateur et un mot de passe (Basic).
OAuth2.
Un jeton obtenu depuis une autre API (une connexion préalable).
Facultatif : choisissez un Certificat client (mTLS).
S'il y a plusieurs étapes, cochez dans Étapes qui utilisent l'authentification celles qui l'utilisent.
Les secrets ne sont jamais affichés et ne figurent jamais dans les résultats.
Étape 4 : les étapes et les variables
Dans Étapes :
Appuyez sur Ajouter une étape (jusqu'à 10). Donnez un nom à chacune.
Avec les boutons de chaque étape, vous pouvez modifier sa requête, la monter, la descendre, la dupliquer ou la retirer.
Dans Variables capturées, appuyez sur Capturer une variable et définissez :
Le nom de la variable, par exemple
tokenoupedido.Sa provenance : Chemin JSON (par exemple
$.data.id), En-tête (par exempleLocation) ou Expression régulière.Secrète, si elle ne doit être ni affichée ni enregistrée.
Utilisez la variable dans les étapes suivantes en écrivant son nom entre doubles accolades, par exemple
{{pedido}}, dans l'URL, les en-têtes, les paramètres ou le corps.
Si une étape utilise une variable qu'aucune étape précédente ne capture, le formulaire vous avertit.
Étape 5 : les validations
Dans Validations, choisissez le type et appuyez sur Ajouter une validation :
Type | Ce qu'elle compare |
|---|---|
Code HTTP | Les codes attendus, comme |
Temps de réponse | Avertissement et critique en millisecondes. |
En-tête | Qu'un en-tête existe, n'existe pas, est égal à ou contient une valeur. |
Corps (texte ou expression) | Que le corps contient, ne contient pas, correspond à l'expression ou ne correspond pas à l'expression. |
Valeur JSON par chemin | Que la valeur à un chemin (par exemple |
Chaque validation est Critique ou d'Avertissement. Une validation critique met le service en panne et arrête les étapes suivantes ; une validation d'avertissement le met en avertissement. Toutes doivent être respectées.
Étape 6 : les métriques
Dans Métriques, tracez des valeurs numériques capturées dans les étapes :
Appuyez sur Ajouter une métrique (jusqu'à 10).
Choisissez la variable (non secrète), saisissez le nom (par exemple Commandes en attente) et l'unité.
Choisissez Alerte si supérieur à ou Alerte si inférieur à et saisissez l'avertissement et le seuil critique.
La latence de chaque étape est toujours tracée.
Étape 7 : où il s'exécute, tester et enregistrer
Dans Où il s'exécute, choisissez Contrôler depuis. Voir Choisir l'origine du contrôle.
Appuyez sur Tester maintenant. En dessous apparaît Résultat de « Tester maintenant » avec l'état, la latence et le détail de chaque étape.
Appuyez sur Enregistrer. S'il manque quelque chose, le formulaire le liste avant d'enregistrer.