Skip to content

NBRS-4942 - Updated Prod Onboarding Guidance #631

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
d-dreyer merged 1 commit into from
Sep 17, 2026
+15 −2
Merged

NBRS-4942 - Updated Prod Onboarding Guidance #631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions ...ionGuide-BaRS/Home/Build/Testing-and-Environments/Connect-as-a-receiver.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,19 @@ There are different certificate chains for INT and PROD:

Your domain must be registered before you begin the process to obtain your certificate generating a certificate request. The fully qualified domain name (FQDN) is equal to the certificate name (CN) by convention.

Step 3: Create a Certificate Signing Request (*.csr). This is the file you will send to us so we can generate a signed certificate for your endpoints. Create a private key; a password is optional.
Step 3: The above steps enables access to the APIM platform. To authorise the access to the BaRS Proxy (which is hosted on the APIM Platform), you must provide the following to the BaRS Team (via email <england.bookingandreferralstandard@nhs.net>):

* App Name*
* App ID (PROD)*
* App ID (INT) (both App IDs are needed to connect to PROD)*
* App Description*
* Connected APIs*
* Name of the Organisation
* ODS code of the Organisation

The starred (\*) items can be found by logging into the [Digital Onboarding Service](https://onboarding.prod.api.platform.nhs.uk) and selecting 'Environment access' under the *Introduction and onboarding* section.

Step 4: Create a Certificate Signing Request (*.csr). This is the file you will send to us so we can generate a signed certificate for your endpoints. Create a private key; a password is optional.
```
openssl genpkey -algorithm RSA -out private.key -aes256
```
Expand All @@ -31,7 +43,7 @@ openssl req -new -key private.key -out request.csr
```
**Note:** <small>_Generate the CSR with only the common name field populated, which must match the FQDN. All other fields can remain blank. The email field MUST be blank. Please note FQDNs MUST be in the .nhs.uk domain as we can only issue certificates in this domain._</small>

Step 4: Send the .csr file to be signed by NHS England and get the client certificate. To do this, follow these environment specific steps:
Step 5: Send the .csr file to be signed by NHS England and get the client certificate. To do this, follow these environment specific steps:

<br>

Expand Down
1 change: 1 addition & 0 deletions ...ationGuide-BaRS/Home/Build/Testing-and-Environments/Connect-as-a-sender.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Step 3: The above steps enables access to the APIM platform. To authorise the ac
* App ID (PROD)*
* App ID (INT) (both App IDs are needed to connect to PROD)*
* App Description*
* Connected APIs*
* Name of the Organisation
* ODS code of the Organisation
* Product Name (as stated in the SCAL or TCC)
Expand Down