We have detected that you are using Internet Explorer to visit this website. Internet Explorer is now being phased out by Microsoft. As a result, NHS Digital no longer supports any version of Internet Explorer for our web-based products, as it involves considerable extra effort and expense, which cannot be justified from public funds. Some features on this site will not work. You should use a modern browser such as Edge, Chrome, Firefox, or Safari. If you have difficulty installing or accessing a different browser, contact your IT support team.
Getting started with NHS Digital APIs
Learn about what APIs we offer, and how you can connect to them. These simple steps will get you creating new software in no time.
1. Learn about our APIs
2. Confirm your use case
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.
3. Create a developer account
If you create a developer account on our API platform, and tell us which APIs you are interested in, we can let you know of any updates.
You'll also be able to manage your applications and teams and get access to security credentials for testing and production.
While our new API management platform is being built, not all of the APIs will be listed, but more will be added over time.
4. Design and build your software
5. Test your software
We provide test environments for you to test your software with our APIs. There are different environments depending on which APIs you are using.
For more details see testing your software.
6. Get your software onboarded
For most of our APIs, before your software can go live you need to complete an onboarding process. 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.
7. Put your software live
Once you’ve completed software onboarding you’re ready to go live.
Get help and support
If you have any issues, either during development or once your software is live, you can get help and support from us.