Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Get Connected

How to get connected to the e-Referral APIs in a few simple steps

Three important things to know

Getting Connected is simple, but there are 3 important things to know:

  1. Your organisation needs to be using a secure Health and Social Care Network (HSCN) Connection (previously N3)
  2. APIs can only be accessed using a smartcard
  3. You will need to apply for a unique End Point and test data

Connections and smartcards

If you do not have a HSCN Connection, please go to the following site to request one:

If you require a smartcard, please go to the following site to find out more:

Access to the Development Environment

Once you have a smartcard and a HSCN connection, you are now ready to request access to our Development Environment in order to integrate with the e-Referral Service APIs. The first thing to do is request a new End Point, unique to your organisation. You can do so by filling in the following form:

Once you have downloaded the form, please enter the following information and return to (platforms.supportdesk@nhs.net)

  1. Enter your name and contact details.
  2. In section 1, enter the FQDN (Fully Qualified Domain Name, must not be the same as an existing FQDN on the organisation code) and IP.
  3. In section 2, enter the ODS (Organisation Data Service) code and name of your allocated testing organisation (i.e. the pack allocated by the test data team).
  4. Enter the Source IP.

Generating a Certificate Signing Request

You will also need to generate and submit a Certificate Signing Request (CSR) and a Private Key to obtain an endpoint certificate for the requested FQDN.

  1. The CSR must have a key length of 2048.
  2. The common name must be set to the FQDN value.

We recommend using OpenSSL for this.

Once installed, Open Command Prompt and run the below command to configure the openssl.cfg file:

C:\OpenSSL-Win32\bin>set OPENSSL_CONF=C:\OpenSSL-Win32\bin\openssl.cfg

Change the directory to C:\OpenSSL-Win32\bin and run the below command to generate the CSR by replacing “Test-FQDN” and the org code, e.g. “O=ROB”, with yours:

openssl req -new -newkey rsa:2048 -nodes -out Test-FQDN.cfh.nhs.uk.csr -keyout Test-FQDN.cfh.nhs.uk.key -subj "/C=GB/ST=/L=na/O=ROB/OU=na/CN=Test-FQDN.cfh.nhs.uk"

The CSR along with the private key will be generated and available in C:\OpenSSL-Win32\bin folder as per the above FQDN details.

Please specify alongside the request to the Platforms Support Desk the need to be allocated a ‘NHS e-RS-API Testing Pack’.

Registry Settings

Please install “IAConfig2.msi” by downloading the IAConfig.zip archive from here:

Once installed you should be able to apply the DEV Registry settings to access the e-RS/DEV1 environment.

Identity Agent

Please install the Identity Agent and Middleware from here:

Unblocking IP addresses

If you want to unblock certain IP addresses as part of this process, please reach out to the Platforms Support Desk (platforms.supportdesk@nhs.net).

Using existing smartcards

Suppliers with existing smartcards in Spine Development can have these remotely updated with the relevant Registration Authority (RA), enabling the allocated UUIDs to be issued locally, please include your Spine Development UUID in your initial request to the Platforms Support Desk (platforms.supportdesk@nhs.net) if this is required.

Those suppliers without existing smartcards in Spine Development can be posted an RA Card for the required organisation(s) so that they can issue their allocated UUIDs locally . Please specify the requirement in your initial request to the Platforms Support Desk and include your Name and Postal Address.

If you have any queries about connecting to Spine Development (smartcards, endpoints, certificates, connectivity, CSRs), please contact the Platforms Support Desk.

Final steps

Once you have received a certificate from our Platforms Support Desk you will need to follow a few simple steps that will allow you to begin your e-Referral Service Integration journey.

You need to install ROOT and SUBCA certificates. Here’s a handy guide to get you started:

Tools for exploration

After this is all set up, you can use either the API Client Demonstrator Tool (also known as Quick Connect) or Postman. In the latter case we recommend you install the full version of Postman tool and not just the Chrome add-in for Postman.

If you go down the API Client Demonstrator Tool route you will need to install Keystore Explorer in order to convert the CSR and private key into a JKS file. Please contact the NHS e-Referrals Integration team and they will be happy to provide more information about how to access this tool.


All content is available under the Open Government Licence v3.0, except where otherwise stated