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 de spécifications en format 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.

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.