Skip to content

NBRS-4885 - Update IG Guidance regarding Sandbox/Dev Environments #632

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
Merged

NBRS-4885 - Update IG Guidance regarding Sandbox/Dev Environments #632

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
1 change: 1 addition & 0 deletions ...ome/Analysis/Releases/Technical-Release-Notes/API-Spec-Change-Log/Index.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,5 @@ This page will list all updates to the BaRS API Specification.
|<mark style="background-color: LightGreen">non-breaking</mark> |Non-breaking changed introduced to the standard since the last release |
|<mark style="background-color: #ff8080">breaking</mark> |Breaking changed introduced to the standard since the last release |
|<mark style="background-color: Yellow">correction</mark> |Correction to the standard since the last release |
<hr>

2 changes: 1 addition & 1 deletion ...S/Home/Analysis/Releases/Technical-Release-Notes/TRN-APP8/1.0.0-alpha.3.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This is a pre-release of v1.0.0-alpha.3 - Referrals into a broker for Healthcare

| Change | Description | Change Type | Impact |
|--------|-------------|-------------|--------|
| Patient Identifier Resource | Updates to Referral Payload Implementation Guidance for multiple elements to improve clarity.|<mark style="background-color: Yellow">correction</mark> | Made corrections to the optionality of some fields, and removed some invalid values that were previously stated as valid. |
| Patient Identifier Resource | Updates to Referral Payload Implementation Guidance for multiple elements to improve clarity.|<mark style="background-color: Yellow">correction</mark> | Made corrections to the necessity of some fields, and removed some invalid values that were previously stated as valid. |
| Scope and Requirements | Minor text changes and link to Hazard Log added|<mark style="background-color: Yellow">correction</mark> | No impact |

### Payload Change Log
Expand Down
5 changes: 2 additions & 3 deletions ...plementationGuide-BaRS/Home/Build/Testing-and-Environments/Certificates.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ All inbound connections to the BaRS API will be presented with environment speci

| Certificate CN | Thumbprint | Parent CN | Parent Thumbprint | Environment |
|----------------------------------|------------------------------------------|----------------------------------|------------------------------------------|-------------|
| dev.api.service.nhs.uk | 8c41b2d0080ff4f83ef4164078d17bab5ed53cbb | DigiCert TLS RSA SHA256 2020 CA1 | 1c58a3a8518e8759bf075b76b750d4f2df264fcd | Sandbox |
| int.api.service.nhs.uk | 634680dfafcf3a6e229741ae7ad5b98dbe70d822 | DigiCert TLS RSA SHA256 2020 CA1 | 1c58a3a8518e8759bf075b76b750d4f2df264fcd | INT |
| api.service.nhs.uk | 2673f9045ba6f8ff8b7b82a9046f9b599af27cab | DigiCert TLS RSA SHA256 2020 CA1 | 1c58a3a8518e8759bf075b76b750d4f2df264fcd | Prod |
| DigiCert TLS RSA SHA256 2020 CA1 | 1c58a3a8518e8759bf075b76b750d4f2df264fcd | DigiCert Global Root CA | a8985d3a65e5e5c4b2d7d66d40c6dd2fb19c5436 | All |
Expand Down Expand Up @@ -171,10 +170,10 @@ ysWdIG7hl3g=

## Outbound

All outbound connections from the BaRS API proxy to Receivers, with the exception of the Sandbox environment, will be secured using TLS-MA.
All outbound connections from the BaRS API proxy to Receivers will be secured using TLS-MA.

### PTL
The PTL environments will present a certificate issued by the NHS PTL Root Authority, as the RootCA. This does not include the Sandbox environment.
The PTL environments will present a certificate issued by the NHS PTL Root Authority, as the RootCA.

Details of the certificate chain described in the table below can be found in the [How to Connect Guidance](https://digital.nhs.uk/services/path-to-live-environments/integration-environment#rootca-and-subca-certificates).

Expand Down
2 changes: 1 addition & 1 deletion ...plementationGuide-BaRS/Home/Build/Testing-and-Environments/Environments.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## {{page-title}}


BaRS Sandbox is available from the [BaRS API specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0). It demonstrates key functionality without the overhead of security requirements, giving developers the opportunity to understand the product before progressing development.
BaRS API usage examples are available from the [BaRS API specification](https://digital.nhs.uk/developer/api-catalogue/booking-and-referral-fhir/v1.3.0). It demonstrates key functionality without the overhead of security requirements, giving developers the opportunity to understand the product before progressing development.

BaRS Integration (INT) is a live-like environment for suppliers progressing with development and testing to use. To use INT, you will need to follow the instructions to {{pagelink:connect-as-a-sender, text:Connect as a sender}} or {{pagelink:connect-as-a-receiver, text:Connect as a receiver}}

Expand Down
2 changes: 0 additions & 2 deletions ...onGuide-BaRS/Home/Core/1-0-7/Security-and-Authorisation/OAuth-Endpoints.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ topic: core-Security-Oauth-1.0.7

| Environment | Endpoint | Usage/Availability |
|------------------|-------------------------------------------|------------------------------------------------------------|
| Sandbox | https://sandbox.api.service.nhs.uk/oauth2 | Authentication is not required in the Sandbox environment. |
| Development | https://dev.api.service.nhs.uk/oauth2 | Limited to specific APIs |
| Integration test | https://int.api.service.nhs.uk/oauth2 | All APIs |
| Production | https://api.service.nhs.uk/oauth2 | All APIs |

Expand Down
2 changes: 0 additions & 2 deletions ...onGuide-BaRS/Home/Core/1-4-0/Security-and-Authorisation/OAuth-Endpoints.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ topic: core-Security-Oauth-1.4.0

| Environment | Endpoint | Usage/Availability |
|------------------|-------------------------------------------|------------------------------------------------------------|
| Sandbox | https://sandbox.api.service.nhs.uk/oauth2 | Authentication is not required in the Sandbox environment. |
| Development | https://dev.api.service.nhs.uk/oauth2 | Limited to specific APIs |
| Integration test | https://int.api.service.nhs.uk/oauth2 | All APIs |
| Production | https://api.service.nhs.uk/oauth2 | All APIs |

Expand Down
2 changes: 0 additions & 2 deletions ...onGuide-BaRS/Home/Core/1-4-1/Security-and-Authorisation/OAuth-Endpoints.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ topic: core-Security-Oauth-1.4.1

| Environment | Endpoint | Usage/Availability |
|------------------|-------------------------------------------|------------------------------------------------------------|
| Sandbox | https://sandbox.api.service.nhs.uk/oauth2 | Authentication is not required in the Sandbox environment. |
| Development | https://dev.api.service.nhs.uk/oauth2 | Limited to specific APIs |
| Integration test | https://int.api.service.nhs.uk/oauth2 | All APIs |
| Production | https://api.service.nhs.uk/oauth2 | All APIs |

Expand Down
2 changes: 0 additions & 2 deletions ...onGuide-BaRS/Home/Core/1-5-0/Security-and-Authorisation/OAuth-Endpoints.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ topic: core-Security-Oauth-1.5.0

| Environment | Endpoint | Usage/Availability |
|------------------|-------------------------------------------|------------------------------------------------------------|
| Sandbox | https://sandbox.api.service.nhs.uk/oauth2 | Authentication is not required in the Sandbox environment. |
| Development | https://dev.api.service.nhs.uk/oauth2 | Limited to specific APIs |
| Integration test | https://int.api.service.nhs.uk/oauth2 | All APIs |
| Production | https://api.service.nhs.uk/oauth2 | All APIs |

Expand Down
2 changes: 0 additions & 2 deletions ...onGuide-BaRS/Home/Core/1-6-0/Security-and-Authorisation/OAuth-Endpoints.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ topic: core-Security-Oauth-1.6.0

| Environment | Endpoint | Usage/Availability |
|------------------|-------------------------------------------|------------------------------------------------------------|
| Sandbox | https://sandbox.api.service.nhs.uk/oauth2 | Authentication is not required in the Sandbox environment. |
| Development | https://dev.api.service.nhs.uk/oauth2 | Limited to specific APIs |
| Integration test | https://int.api.service.nhs.uk/oauth2 | All APIs |
| Production | https://api.service.nhs.uk/oauth2 | All APIs |

Expand Down
2 changes: 0 additions & 2 deletions ...onGuide-BaRS/Home/Core/1.0.3/Security-and-Authorisation/OAuth-Endpoints.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ topic: core-Security-Oauth-1.0.3

| Environment | Endpoint | Usage/Availability |
|------------------|-------------------------------------------|------------------------------------------------------------|
| Sandbox | https://sandbox.api.service.nhs.uk/oauth2 | Authentication is not required in the Sandbox environment. |
| Development | https://dev.api.service.nhs.uk/oauth2 | Limited to specific APIs |
| Integration test | https://int.api.service.nhs.uk/oauth2 | All APIs |
| Production | https://api.service.nhs.uk/oauth2 | All APIs |

Expand Down
2 changes: 0 additions & 2 deletions ...onGuide-BaRS/Home/Core/1.0.4/Security-and-Authorisation/OAuth-Endpoints.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ topic: core-Security-Oauth-1.0.4

| Environment | Endpoint | Usage/Availability |
|------------------|-------------------------------------------|------------------------------------------------------------|
| Sandbox | https://sandbox.api.service.nhs.uk/oauth2 | Authentication is not required in the Sandbox environment. |
| Development | https://dev.api.service.nhs.uk/oauth2 | Limited to specific APIs |
| Integration test | https://int.api.service.nhs.uk/oauth2 | All APIs |
| Production | https://api.service.nhs.uk/oauth2 | All APIs |

Expand Down
2 changes: 0 additions & 2 deletions ...onGuide-BaRS/Home/Core/1.0.5/Security-and-Authorisation/OAuth-Endpoints.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ topic: core-Security-Oauth-1.0.5

| Environment | Endpoint | Usage/Availability |
|------------------|-------------------------------------------|------------------------------------------------------------|
| Sandbox | https://sandbox.api.service.nhs.uk/oauth2 | Authentication is not required in the Sandbox environment. |
| Development | https://dev.api.service.nhs.uk/oauth2 | Limited to specific APIs |
| Integration test | https://int.api.service.nhs.uk/oauth2 | All APIs |
| Production | https://api.service.nhs.uk/oauth2 | All APIs |

Expand Down
2 changes: 0 additions & 2 deletions ...onGuide-BaRS/Home/Core/1.0.6/Security-and-Authorisation/OAuth-Endpoints.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ topic: core-Security-Oauth-1.0.6

| Environment | Endpoint | Usage/Availability |
|------------------|-------------------------------------------|------------------------------------------------------------|
| Sandbox | https://sandbox.api.service.nhs.uk/oauth2 | Authentication is not required in the Sandbox environment. |
| Development | https://dev.api.service.nhs.uk/oauth2 | Limited to specific APIs |
| Integration test | https://int.api.service.nhs.uk/oauth2 | All APIs |
| Production | https://api.service.nhs.uk/oauth2 | All APIs |

Expand Down
2 changes: 0 additions & 2 deletions ...onGuide-BaRS/Home/Core/1.1.3/Security-and-Authorisation/OAuth-Endpoints.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ topic: core-Security-Oauth-1.1.3

| Environment | Endpoint | Usage/Availability |
|------------------|-------------------------------------------|------------------------------------------------------------|
| Sandbox | https://sandbox.api.service.nhs.uk/oauth2 | Authentication is not required in the Sandbox environment. |
| Development | https://dev.api.service.nhs.uk/oauth2 | Limited to specific APIs |
| Integration test | https://int.api.service.nhs.uk/oauth2 | All APIs |
| Production | https://api.service.nhs.uk/oauth2 | All APIs |

Expand Down
2 changes: 0 additions & 2 deletions ...onGuide-BaRS/Home/Core/1.1.4/Security-and-Authorisation/OAuth-Endpoints.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ topic: core-Security-Oauth-1.1.4

| Environment | Endpoint | Usage/Availability |
|------------------|-------------------------------------------|------------------------------------------------------------|
| Sandbox | https://sandbox.api.service.nhs.uk/oauth2 | Authentication is not required in the Sandbox environment. |
| Development | https://dev.api.service.nhs.uk/oauth2 | Limited to specific APIs |
| Integration test | https://int.api.service.nhs.uk/oauth2 | All APIs |
| Production | https://api.service.nhs.uk/oauth2 | All APIs |

Expand Down
2 changes: 0 additions & 2 deletions ...onGuide-BaRS/Home/Core/1.1.5/Security-and-Authorisation/OAuth-Endpoints.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ topic: core-Security-Oauth-1.1.5

| Environment | Endpoint | Usage/Availability |
|------------------|-------------------------------------------|------------------------------------------------------------|
| Sandbox | https://sandbox.api.service.nhs.uk/oauth2 | Authentication is not required in the Sandbox environment. |
| Development | https://dev.api.service.nhs.uk/oauth2 | Limited to specific APIs |
| Integration test | https://int.api.service.nhs.uk/oauth2 | All APIs |
| Production | https://api.service.nhs.uk/oauth2 | All APIs |

Expand Down
2 changes: 0 additions & 2 deletions ...onGuide-BaRS/Home/Core/1.1.6/Security-and-Authorisation/OAuth-Endpoints.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ topic: core-Security-Oauth-1.1.6

| Environment | Endpoint | Usage/Availability |
|------------------|-------------------------------------------|------------------------------------------------------------|
| Sandbox | https://sandbox.api.service.nhs.uk/oauth2 | Authentication is not required in the Sandbox environment. |
| Development | https://dev.api.service.nhs.uk/oauth2 | Limited to specific APIs |
| Integration test | https://int.api.service.nhs.uk/oauth2 | All APIs |
| Production | https://api.service.nhs.uk/oauth2 | All APIs |

Expand Down
2 changes: 0 additions & 2 deletions ...onGuide-BaRS/Home/Core/1.2.0/Security-and-Authorisation/OAuth-Endpoints.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ topic: core-Security-Oauth-1.2.0

| Environment | Endpoint | Usage/Availability |
|------------------|-------------------------------------------|------------------------------------------------------------|
| Sandbox | https://sandbox.api.service.nhs.uk/oauth2 | Authentication is not required in the Sandbox environment. |
| Development | https://dev.api.service.nhs.uk/oauth2 | Limited to specific APIs |
| Integration test | https://int.api.service.nhs.uk/oauth2 | All APIs |
| Production | https://api.service.nhs.uk/oauth2 | All APIs |

Expand Down
2 changes: 0 additions & 2 deletions ...onGuide-BaRS/Home/Core/1.2.1/Security-and-Authorisation/OAuth-Endpoints.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ topic: core-Security-Oauth-1.2.1

| Environment | Endpoint | Usage/Availability |
|------------------|-------------------------------------------|------------------------------------------------------------|
| Sandbox | https://sandbox.api.service.nhs.uk/oauth2 | Authentication is not required in the Sandbox environment. |
| Development | https://dev.api.service.nhs.uk/oauth2 | Limited to specific APIs |
| Integration test | https://int.api.service.nhs.uk/oauth2 | All APIs |
| Production | https://api.service.nhs.uk/oauth2 | All APIs |

Expand Down
2 changes: 0 additions & 2 deletions ...onGuide-BaRS/Home/Core/1.2.2/Security-and-Authorisation/OAuth-Endpoints.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ topic: core-Security-Oauth-1.2.2

| Environment | Endpoint | Usage/Availability |
|------------------|-------------------------------------------|------------------------------------------------------------|
| Sandbox | https://sandbox.api.service.nhs.uk/oauth2 | Authentication is not required in the Sandbox environment. |
| Development | https://dev.api.service.nhs.uk/oauth2 | Limited to specific APIs |
| Integration test | https://int.api.service.nhs.uk/oauth2 | All APIs |
| Production | https://api.service.nhs.uk/oauth2 | All APIs |

Expand Down
2 changes: 0 additions & 2 deletions ...onGuide-BaRS/Home/Core/1.3.0/Security-and-Authorisation/OAuth-Endpoints.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ topic: core-Security-Oauth-1.3.0

| Environment | Endpoint | Usage/Availability |
|------------------|-------------------------------------------|------------------------------------------------------------|
| Sandbox | https://sandbox.api.service.nhs.uk/oauth2 | Authentication is not required in the Sandbox environment. |
| Development | https://dev.api.service.nhs.uk/oauth2 | Limited to specific APIs |
| Integration test | https://int.api.service.nhs.uk/oauth2 | All APIs |
| Production | https://api.service.nhs.uk/oauth2 | All APIs |

Expand Down
2 changes: 0 additions & 2 deletions ...onGuide-BaRS/Home/Core/1.3.1/Security-and-Authorisation/OAuth-Endpoints.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ topic: core-Security-Oauth-1.3.1

| Environment | Endpoint | Usage/Availability |
|------------------|-------------------------------------------|------------------------------------------------------------|
| Sandbox | https://sandbox.api.service.nhs.uk/oauth2 | Authentication is not required in the Sandbox environment. |
| Development | https://dev.api.service.nhs.uk/oauth2 | Limited to specific APIs |
| Integration test | https://int.api.service.nhs.uk/oauth2 | All APIs |
| Production | https://api.service.nhs.uk/oauth2 | All APIs |

Expand Down
1 change: 0 additions & 1 deletion ...ive-ImplementationGuide-BaRS/Home/Deploy/Deploy/KeyDeploymentActivities.page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ There are numerous stages, environments, and systems involved. NHS England (BaRS

| Testing Stage | NHS Environment | BaRS API (API-M) | Solution Environment | DoS (if required) |
|-----------------------|------------------|------------------------------|---------------------------|-------------------------|
| API Spec 'Try this API'| Sandbox | sandbox.api.service.nhs.uk | | |
| INT Development | INT | int.api.service.nhs.uk | Development (supplier) | UserTest |
| INT Assurance | INT | int.api.service.nhs.uk | Development (supplier) | UserTest |
| UAT Testing | INT | int.api.service.nhs.uk | UAT (provider) | UserTest |
Expand Down
Loading