Here's how to get your team working with our APIs.
Whether you're a product owner, delivery lead, architect, software developer or a business analyst, you'll have a part to play in this process.
Follow these seven steps to get working with our APIs as quickly as possible.
If you run into any issues, you can always get help and support from us.
Confirm your use case
Our APIs are provided to support the delivery of health and social care, primarily in England.
For some of our APIs, you must check you have a valid use case. You’ll need to give us details of your product and what it does.
You should do this before you go too far with your development.
For more details on how to confirm your use case for a particular API, read its API specification in our API catalogue.
Get your software onboarded
For most of our APIs, before your software can go live you need to complete an onboarding process, such as 'SCAL' or 'digital onboarding'. This mostly involves making sure your software complies with various regulations and laws, such as security, clinical safety, information governance. We sometimes also call this software assurance.
It can take quite a long time, so it's worth planning well ahead.
For more details see onboarding process for APIs.
Last edited: 12 April 2022 1:00 pm