Surveillance d’API

Les moniteurs API envoient une requête HTTP configurable à un point de terminaison toutes les 30 secondes et vous alertent lorsqu’il est injoignable, lent ou renvoie de mauvaises données. Vous contrôlez la méthode, les en-têtes, le corps et l’authentification, et vérifiez le code de statut, le corps JSON, les en-têtes et le temps de réponse.

Comme pour les autres moniteurs, si un moniteur d’API détecte un problème, vous pouvez travailler avec votre équipe pour résoudre l’incident et, si vous le souhaitez, mettre à jour votre page de statut.

Que vérifie un moniteur API ?

• Testez vos points de terminaison depuis plusieurs emplacements dans le monde, toutes les 30 secondes.
• Validez les codes de statut HTTP, le corps JSON, les en-têtes et les temps de réponse.
• Ajoutez des en-têtes personnalisés, des paramètres de requête ou des charges utiles JSON.
• Recevez des notifications immédiates si un point de terminaison est indisponible, lent ou renvoie des résultats inattendus.
• Intégrez Slack, l’e-mail, les SMS, les appels téléphoniques, les webhooks et plus encore.

Comment ajouter un moniteur API ?

Allez dans votre projet → Moniteurs → Ajouter un moniteur, choisissez API, saisissez l’URL du point de terminaison, configurez la requête et définissez les assertions qui indiquent que le point de terminaison fonctionne correctement.

Type de moniteur

Choisissez API comme type de moniteur.

Saisissez l’URL du point de terminaison à surveiller — par exemple,
https://api.yourservice.com/v1/users.

Configuration de la requête

Vous pouvez adapter entièrement votre requête d’API :

• Méthode HTTP : GET, POST, PUT, PATCH, DELETE, OPTIONS ou HEAD
• Corps : envoyez du JSON, des données de formulaire, du GraphQL ou du texte brut avec votre requête
• Authentification : ajoutez une authentification basique, une clé d’API ou un jeton Bearer
• Paramètres de requête : ajoutez des paires clé/valeur à l’URL de votre requête
• En-têtes : ajoutez les en-têtes personnalisés requis par votre requête d’API

Le moniteur réussit si

Un moniteur d’API réussit lorsque toutes les assertions définies sont satisfaites.
Vous pouvez définir une ou plusieurs des assertions suivantes :

• Code de statut : par exemple, la réponse est 200 OK
• Temps de réponse : par exemple, moins d’1 seconde
• Le corps contient : par exemple, "success": true
• Chemin JSON : par exemple, data.status vaut "active"
• L’en-tête contient : par exemple, Content-Type: application/json

Si l’une de ces conditions n’est pas remplie, le moniteur est marqué comme indisponible et des alertes sont envoyées selon vos paramètres d’alerte.

Paramètres avancés

• Nom convivial : attribuez un nom explicite à votre moniteur pour l’identifier plus facilement.
• Exécuter les vérifications toutes les : choisissez la fréquence de test du point de terminaison.
• Exécuter depuis : choisissez les emplacements de test (États-Unis, Canada, Europe, Asie).
• Ajouter à la page de statut : affichez publiquement la disponibilité et les statistiques de réponse de l’API.
• Quand un moniteur échoue : ouvrez un incident, notifiez les abonnés ou publiez sur votre page de statut.
• Quand un moniteur se rétablit : résolvez les incidents et mettez à jour automatiquement votre page de statut.