Who is this article for?

Administrators who want guidance on the Assurance API endpoint.

Administration Access is required.

1. What does the Assurance API endpoint do?

Administrators of Assurance can send data to create a form on a register using the Assurance API Endpoint.

2. What do I need set up in Assurance?

Three things need to be completed on your Assurance site to use the API endpoint: API add on, API key and register template for the API endpoint.

1. To request the API addon be enabled for your Assurance site and to access our Swagger documentation, contact our Support team.

2. Once the add on has been enabled for your Assurance site, navigate to:

• Administration
• Integrations
• API
• API Key

On this screen, you will be able to create the API Key needed in swagger:

3. To send data to create a form on a register, you will need a register template set up with fields created that match the fields you will send via the API.

3. What is next?

Now that Assurance is set up, it is time to complete connecting to the API endpoint.

• For setup instructions, refer to the Assurance API Endpoint | Setup Guide.
• For additional technical guidance, consult the Assurance API Endpoint | Developers Integration Guide.

4. What if I experience an API outage?

If you encounter any 5XX error responses from our servers, it indicates an unexpected spike in API access traffic. We will be back in operation shortly. If the issue persists, please contact our Support team.

Important note

The v1 endpoint for Assurance reports is deprecated as of 1 December 2023. While it will continue to work through the new year, we strongly encourage anyone using the Assurance API reports to adopt the v2 version of the endpoint. (Just substitute 'v2' for 'v1' in the URL - everything else is identical.) The reason for this is that the v1 endpoint can hit certain internal limits when it comes to returning large amounts of data. The v2 version does not have that restriction - although, for really large datasets, we would encourage users to adopt the cache/snapshot strategy detailed in this guide.

You will notice the following changes:

• When using the Swagger-UI frontend, the v1 endpoint is greyed out (although still usable)
• Requests to the v1 version will now return a Deprecated HTTP header in the API response.

Setup Guide →