The developer hub seeks to make learning easier. It is a ‘one stop shop’ to connect your apps to our APIs and integrate with official NHS services. There are three key areas of the developer hub that help improve access:
1. API catalogue
The API catalogue is a single source of truth that lists all NHS Digital APIs. This aims to make sure you can find all our API options in one place, to see what’s available but also to expose alternative options that you may not have previously considered.
To make exploring our APIs easier, we have set up numerous filter options:
⦁ business use
⦁ care setting
⦁ API service and standard
⦁ API status
For example, if you wanted to look at vaccination related APIs, you can see all 6 options in just two clicks.
Filters are also bookmarkable so you could, for example, send a colleague a link to all our MESH APIs.
You can access the API Catalogue on the NHS Digital website.
2. Individual API specifications
Once you have found an API you are interested in, simply click into it to see the API specification. Our API specifications make learning about each API easier. Here you will find content around that specific API, with information including:
⦁ an overview, written in plain English
⦁ who can use this API
⦁ related APIs
⦁ API status and roadmap
⦁ service level
⦁ network access
⦁ security and authorisation
⦁ environments and testing
This aims to give you the information you need when deciding which of our APIs you want to
integrate with, and how to get started doing so.
3. Documentation, guides and tutorials
We also provide a range of other resources, including but not limited to:
⦁ tutorials and open-access sandboxes
⦁ onboarding processes for APIs
⦁ specific challenge related developer guides
⦁ how we handle security and authorisation
⦁ glossary of developer terms