Skip to main content

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

Before designing your software, you should:

2. 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.

3. Design and build your software

When designing and building your software you can:

4. 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.

5. 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.

6. 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.

Last edited: 15 May 2020 11:02 am