API Enhancements

We have made 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 have we released?

The additional capabilities in this will include the abilities to:

  • Create a more detailed Application, providing more information than before.
  • Change an Applications programme after it has been created in Bud.
  • Change an Applications Employer after it has been created in Bud.
  • Change an Applications Personal Details after it has been created in Bud.
  • Get a list of Applications by their status, email address, applicant name, programme, Employer or National Insurance number.
  • Invite an Applicant to Bud, after they have been created.
  • Setup and invite an Applicant to complete there Cognassist assessments.

 

What do you need to do?

Nothing initially. 

Now the new APIs are available, we recommend you begin a plan 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