Skip to content

Commit b5ec68d

Browse files
authored
SYN-774: Updated the ‘Security and authorisation’ text (#112)
* Updated the ‘Security and authorisation’ text * Added (Example apikey) * Lowercase ‘e’ * Changed wording
1 parent 98c366d commit b5ec68d

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

specification/nhs-website-content-api.yaml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,15 @@ info:
8383
8484
## Security and authorisation
8585
86-
This access mode is [application-restricted](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation#application-restricted-apis), meaning we authenticate the calling application but not the end user.
86+
This API use the [Application-restricted RESTful API - API key authentication](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-api-key-authentication) security pattern, meaning we authenticate the calling application but not the end user.
8787
88-
To use this access mode, use the following security pattern:
89-
* [Application-restricted RESTful API - API key authentication](https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-api-key-authentication).
88+
When calling the Integration Test environment or Production environment, you must provide a valid `apikey` in your request header.
89+
90+
To obtain an API key for each of these environments you must sign in to the [NHS Digital Onboarding Service - Developer account](https://onboarding.prod.api.platform.nhs.uk/Index) and register your application to be granted [environment access](https://onboarding.prod.api.platform.nhs.uk/MyApplications).
91+
92+
Your API keys will look something like: `XW7DGBVQzO0yPKdPbRXeqITzbdJ1jNh7` (example apikey)
93+
94+
<strong>NOTE:</strong> You will not need the 'Secret', and you don't need to specify a 'Public key URL' or a 'Callback URL' to use this API.
9095
9196
## Errors
9297
We use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:

0 commit comments

Comments
 (0)