Assurance API endpoint introduction

What does the Assurance API endpoint do?

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

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. Contact the service desk to turn on the API add on and for access to our swagger documentation

2. Once the add on is confirmed on, 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 setup with fields created that match the fields you will send via the API

What is next? 

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

Use this article for setup:

The Assurance API endpoint

For further technical guidance read:

Developers integration guide for the Assurance API endpoint

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.