Skip to content

Commit 74a3a63

Browse files
authored
Added a Postman collection to the spec (#40)
* Added the Postman Collection JSON file * Added a ‘Run in Postman’ button to the spec * Removed the line that mentions ‘stateless’ etc…
1 parent 88201cf commit 74a3a63

2 files changed

Lines changed: 1863 additions & 0 deletions

File tree

specification/nhs-website-content-api.yaml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,29 @@ info:
6161
## Environments and testing
6262
| Environment | Base URL |
6363
| ----------------- | ---------------------------------------------------------------------- |
64+
| Sandbox | `https://sandbox.api.service.nhs.uk/nhs-website-content/` |
6465
| Integration test | `https://int.api.service.nhs.uk/nhs-website-content/` |
6566
| Production | Not available yet |
6667
68+
### Sandbox testing
69+
Our [sandbox environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#sandbox-testing):
70+
* is for early developer testing
71+
* only covers a limited set of scenarios
72+
* is open access, so does not allow you to test authorisation
73+
74+
For details of sandbox test scenarios, or to try out the sandbox using our 'Try this API' feature, see the documentation for each endpoint.
75+
76+
Alternatively, you can try out the sandbox using our Postman collection:
77+
78+
[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/222854-9766f4d9-e6b9-41ec-8949-ef3758316de0)
79+
80+
### Integration testing
81+
Our [integration test environment](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing):
82+
* is for formal integration testing
83+
* includes authorisation via an API Key
84+
85+
For more details see [integration testing with our RESTful APIs](https://digital.nhs.uk/developer/guides-and-documentation/testing#integration-testing-with-our-restful-apis).
86+
6787
## Onboarding
6888
The onboarding journey for this API is currently in development.
6989

0 commit comments

Comments
 (0)