We’re making significant improvements to our API offering, aimed at giving you a more reliable, robust and scalable experience.
What’s changing?
We’re moving our existing APIs to a Microsoft API Management (APIM) gateway. This is an internal change – you won’t need to do anything at this stage, and your existing integrations will continue to work without interruption.
Why are we doing this?
The migration to APIM gives us much better visibility of how our APIs are used – including logging, error reporting and performance monitoring. This means we can respond faster to issues, improve stability, and scale more effectively.
More importantly, it lays the groundwork for a new suite of APIs we’re building.
What’s coming?
Once the migration is complete, we’ll start releasing new and improved APIs on the APIM gateway. These will include:
- Enhanced functionality, for example:
- The ability to update an Application after it has been created.
- Omit an Employer from the initial create, and update it later.
- Search and retrieve applications by more than just an ID.
- Better error handling when things go wrong.
- Improved documentation and developer support.
We’ll share details of the new APIs as they’re released.
What will you need to do?
Nothing initially.
Once the new APIs are available, we will ask you to migrate to the new APIs. This will require some development work on your side, and we’ll provide clear guidance and support throughout that process. Moving to the new APIs will provide you with a lot more functionality and benefits, so we will be encouraging everyone to move over.
Eventually, we’ll decommission the old APIs, which we will aim to do before 2026, but only once everyone has moved over.
Related to