API migration frequently asked questions
When will the new Content API be available?
Due to unforeseen circumstances the launch of the new Content API has been delayed. We will communicate a new date for the launch of the API as soon as we know this.
What's happening to the Service Search API and the Ratings and Reviews API?
The Service Search API and the Ratings and Reviews API will also be migrated to the NHS England API platform. The Service Search API is already being added to the platform, and when it is ready we will let you know how to start using it. The Ratings and Reviews API will be migrated to the platform after both the merged Content API and the Service Search API have been set up on the NHS England API platform.
When will the old APIs stop working?
The old APIs will be maintained until all users have had time to migrate. We will communicate with you before the APIs stop working.
When can we access the new platform?
You can sign up to the new platform at https://digital.nhs.uk/developer. When the new API is up and running you will be able to access it. We will supply detailed guidance on how to do this.
How is the new platform different to the current platform?
The new platform hosts many NHS APIs. It enables sandboxing environments and has an online developer community where API users can communicate with each other and get advice.
Where is the documentation for the new API?
The documentation for the new API will be published on the NHS England API platform. We will let you know where to find it when it's ready.
What will the migration involve?
The migration will involve signing up to the NHS England API platform at https://digital.nhs.uk/developer, generating a new subscription key (apikey), and then changing the endpoints you use to consume the current APIs. We will publish detailed guidance on the current developer portal (developer.api.nhs.uk) to walk you through the process. The structure of the JSON responses will remain unchanged.
What are the differences between the old and new APIs?
There is no difference in functionality between the old and new APIs.
The new Content API integrates the functionality of all the following APIs:
- Common Health Questions
- Conditions (Health A-Z)
- Live Well
- Medicines
- Mental Health
- NHS Services
- Pregnancy
This means you will not need to be subscribed to multiple APIs to consume textual content and images from different areas of the NHS website.
Who can we contact with queries?
You can use the contact form at https://www.nhs.uk/contact-us/nhs-website-contact-us to get in touch with us.
What are some of the benefits to the migration?
The new merged API will mean that you only have to sign up to one API to consume textual content, pictures and videos from the NHS website, rather than different APIs for different areas of content. You will also only need one key to access the API.
The new platform has an online developer community where you can communicate with other people using the API and ask questions - we hope that this means you will be able to resolve problems more quickly and easily.
The roadmap for the NHS England API platform is published openly and this should help you to see what new features are coming up. You can also suggest new features. The platform hosts a range of NHS APIs.
When will the new Service Search API be available?
We plan for the new Service Search API to be available from July, we will provide exact dates when these are known.
When will the new Ratings and Reviews API be available?
We plan for the new Ratings and Reviews API to be available later in the summer. We will provide exact dates when these are known.
What are the next steps for the migration?
We will support the migration of the Service Search API to the new platform, and then the Ratings and Reviews API. The migration of the merged Content API has been delayed, but we hope to be able to start this soon.
What are some of the benefits to the migration?
The new platform has an online developer community where you can communicate with other people using the API and ask questions - we hope that this means you will be able to resolve problems more quickly and easily.
The roadmap for the NHS England API platform is published openly and this should help you to see what new features are coming up. You can also suggest new features. The platform hosts a range of NHS APIs.
The new merged Content API will mean that you only have to sign up to one API to consume textual content and images from the NHS website, rather than different APIs for different areas of content. You will also only need one key to access the API.