Skip to content

Commit fc599ba

Browse files
authored
Merge pull request #631 from NHSDigital/NBRS-4942_Update-Prod-Onboarding-Guidance
NBRS-4942 - Updated Prod Onboarding Guidance
2 parents 4bf2a5b + de12acf commit fc599ba

2 files changed

Lines changed: 15 additions & 2 deletions

File tree

guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Connect-as-a-receiver.page.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,19 @@ There are different certificate chains for INT and PROD:
2020

2121
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.
2222

23-
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.
23+
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>):
24+
25+
* App Name*
26+
* App ID (PROD)*
27+
* App ID (INT) (both App IDs are needed to connect to PROD)*
28+
* App Description*
29+
* Connected APIs*
30+
* Name of the Organisation
31+
* ODS code of the Organisation
32+
33+
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.
34+
35+
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.
2436
```
2537
openssl genpkey -algorithm RSA -out private.key -aes256
2638
```
@@ -31,7 +43,7 @@ openssl req -new -key private.key -out request.csr
3143
```
3244
**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>
3345

34-
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:
46+
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:
3547

3648
<br>
3749

guides/Live-ImplementationGuide-BaRS/Home/Build/Testing-and-Environments/Connect-as-a-sender.page.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Step 3: The above steps enables access to the APIM platform. To authorise the ac
2222
* App ID (PROD)*
2323
* App ID (INT) (both App IDs are needed to connect to PROD)*
2424
* App Description*
25+
* Connected APIs*
2526
* Name of the Organisation
2627
* ODS code of the Organisation
2728
* Product Name (as stated in the SCAL or TCC)

0 commit comments

Comments
 (0)