Skip to main content
Creating a new NHS England: NHS England and NHS Digital merged on 1 February 2023. All references to NHS Digital now, or in the future, relate to NHS England. More about the merger.

Tutorials

Hands-on tutorials to help you learn how to connect to our APIs.

Overview

Many of our APIs give access to sensitive or personal data. Each API is secured using an appropriate security pattern.

The security patterns are in three categories:

  • open-access APIs
  • application-restricted APIs
  • user-restricted APIs​

This page contains tutorials which show you how to connect to our example Hello World API using each security pattern.​


Open-access REST API tutorials

These tutorials show you how to connect to an open-access REST API using:

and also using the "Try this API" feature.​​


Application-restricted REST API tutorials

You can use the following security patterns to connect to an application-restricted REST API:

  • signed JWT authentication

  • API key authentication​

Signed JWT authentication tutorials

These tutorials show you how to use the signed JWT authentication pattern using:

API key authentication tutorials

These tutorials show you how to use the API key authentication pattern using:​


User-restricted REST API tutorials

These tutorials show you how to connect to an user-restricted REST API.​

Two types of end user can access user-restricted APIs:

Users can be authenticated and authorised using:

  • separate authentication and authorisation - where these are done separately
  • combined authentication and authorisation - where these are done together

These tutorials show you how to use NHS CIS2 - separate authentication and authorisation using:

These tutorials show you how to use NHS CIS2 - combined authentication and authorisation using:

These tutorials show you how to use NHS login - separate authentication and authorisation using:

These tutorials show you how to use NHS login - combined authentication and authorisation using:

and also using the "Try this API" feature.


Sandboxes

Some of our APIs have open-access sandboxes you can use for learning, experimentation and early testing.

For more details, see sandbox testing.

Last edited: 13 October 2022 3:06 pm