Error Response Message Updates

Expected: August & September 2021

We are committed to making continual upgrades and additions to the Connect API. As part of this ongoing initiative, we are currently making a change to the underlying API platform technology.

We aim to complete the technology transition during Q3 2021, delivering greater stability and load capacity to the API. As part of the transition, we will first implement the changes on the Connect API Sandbox environment during the week commencing 9th August. It is then our aim to push the changes through to the Live environment on the weekend of the 4th-5th September.  Please be aware that these dates may be subject to change, and we will confirm go-live dates closer to the time.

What is changing and how it may impact your integration.

 

The changes to the underlying API platform technology will not require any changes for a large majority of customers. However, a small number of customers may require a small change to their integration. Part of this update will be around the error message responses for invalid requests.

These scenarios are unlikely to be invoked or handled explicitly in your integration, as they only concern badly formed requests (that have little-to-no purpose in an integration), which have always been incorrect and will unlikely ever generate the correct response without changing the nature of the request. 

The errors are likely to be encountered only during your development phase and not through expected error scenarios (such as a failed report, or no search results). We advise checking that you are not relying on any of the scenarios outlined in the change details document within your integration as the response may change.

We do strongly advise that you check your integration via our Sandbox environment once that environment has been updated. Please note, you may require a separate user account to be able to access the sandbox environment.

If you have any questions, please do not hesitate to contact our support team at [email protected]