Bienvenue
Connexion
Ouvrir la navigation

Comment vérifier que mon API est accessible avec une API de contrôle ?

En tant que fournisseur, lors du dépôt de votre offre de donnée par API Pull, au moment de la configuration de cette dernière, vous pouvez vérifier l’accessibilité de votre API de deux façons : 

  1. Validation de votre configuration :  La plateforme vérifie qu’elle peut se connecter à votre endpoint et s’assure que votre configuration est correcte

  2. En ajoutant une API de contrôle : Vous devez renseigner une URL. La plateforme testera alors régulièrement la connexion à votre API. 



L’ajout d’une API de contrôle n’est pas obligatoire. 


Ajout d’une API de contrôle et ou pas, au moment du dépôt de votre offre de données, la validation de votre configuration est une étape obligatoire. 

Si vous décidez d’ajouter une API de contrôle, La plateforme utilise l’API de contrôle (HealthCheck) pour monitorer la disponibilité de votre API. Ces tests permettent de vous alerter en cas d’indisponibilité. Le endpoint ne sera pas testé. 



Cas d’usage

Ajouter un Health Check permet d’éviter l’envoi d’un test sur votre endpoint au moment où ce dernier est déjà sollicité par vos clients. 

Cette réponse a-t-elle été utile ? Oui Non

Envoyer vos commentaires
Désolés de n'avoir pu vous être utile. Aidez-nous à améliorer cet article en nous faisant part de vos commentaires.