Bienvenue
Connexion
Ouvrir la navigation

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

En tant que fournisseur de données, lors du dépôt de votre offre via l'API Pull, vous pouvez vérifier l'accessibilité de votre API de deux façons pendant sa configuration : 

  1. Validation de votre configuration :  

    1. Intégration manuelle : le portail participant vérifie qu’il peut se connecter à chaque endpoint renseigné et s’assure que votre configuration est correcte

    2. Import en OpenApi : le portail participant vérifie qu’il peut se connecter à l’un des endpoints renseignés et s’assure que la configuration est correcte

  2. En ajoutant une API de contrôle

    1. Intégration manuelle : Vous devez renseigner une URL. Le portail participant testera alors régulièrement la connexion à votre API. 

    2. Import en OpenAPI : 

      1. Vous pouvez renseigner une URL de Healthcheck. Le portail participant testera alors régulièrement la connexion à votre API.

      2. Vous pouvez exécuter la vérification sur le même endpoint que celui utilisé pour la vérification de la configuration.

L’ajout d’une API de contrôle n’est pas obligatoire, contrairement à la validation de votre configuration, mais est un gage de qualité supplémentaire.

À noter
Dans le cadre d’une offre de données par API PULL dont l’import de la configuration s’est fait en OpenAPI, les acquéreurs de données seront bientôt informés sur la fiche de votre offre de données si vous n’avez pas activé l’API de contrôle. 

Vous pouvez à tout moment lancer un test manuellement
En cas d’erreur, vous pouvez en consulter le détail.


Utilisation de l’API de contrôle :  le portail participant utilise l’API de contrôle (HealthCheck) pour monitorer la disponibilité de votre API. Ces tests permettent de vous alerter en cas d’indisponibilité. 
À noter : 

  • Le endpoint ne sera pas testé. 

  • Vous pouvez retrouver ces tests à tout moment dans le détail de votre API.

Pourquoi ajouter un Health Check ?

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. 

Il s’agit également d’un gage de qualité supplémentaire pour vos potentiels acquéreurs de données.


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.