How to check that your API is accessible with a control API?

As a data provider, when submitting your offering via the Pull API, you can check the accessibility of your API in two ways during its configuration: 

1. Validation of your configuration:  

   1. Manual integration: the Participant Portal checks that it can connect to each endpoint and that your configuration is correct.

   2. Import into OpenApi: the Participant Portal checks that it can connect to any of the endpoints entered, and ensures that the configuration is correct.

2. By adding a control API: 

   1. Manual integration: you must enter a URL. The portal will then regularly test the connection to your API. 

   2. OpenAPI import: 

      1. You can enter a Healthcheck URL. The portal will then regularly test the connection to your API.

      2. You can run the check on the same endpoint used for the configuration check.

Use of the control API:  the portal uses the control API (HealthCheck) to monitor the availability of your API. These tests will alert you in case of unavailability. The endpoint will not be tested.
For your information: 

• The endpoint will not be tested. 

• You can find these tests at any time in your API details.

  Why add a Health Check ? Adding a Health Check means you don't have to send a test to your endpoint when it's already being used by your clients.  It is also an additional guarantee of quality for your potential data acquirers.