Skip to content

NHSO-61032: Dep documentaion and postman collection changes #309

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
lambodarpadhy1 merged 2 commits into from
Sep 29, 2025
Merged

NHSO-61032: Dep documentaion and postman collection changes #309

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
daec06f
NHSO-61032: Dep documentaion and postman collection changes
lambodarpadhy1 Sep 29, 2025
311c7e3
NHSO-61032: Review comments
lambodarpadhy1 Sep 29, 2025
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
4 changes: 2 additions & 2 deletions postman/NHS App - dev (NHS Login sandpit).postman_environment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"values": [
{
"key": "base_url",
"value": "https://dev.api.service.nhs.uk",
"value": "https://dep.api.service.nhs.uk",
"enabled": true
},
{
Expand Down Expand Up @@ -41,4 +41,4 @@
"_postman_variable_scope": "environment",
"_postman_exported_at": "2021-02-10T23:55:54.828Z",
"_postman_exported_using": "Postman/7.36.3"
}
}
123 changes: 123 additions & 0 deletions postman/NHS App.postman_collection.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,19 @@
"type": "text/javascript",
"packages": {}
}
},
{
"listen": "prerequest",
"script": {
"exec": [
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"nhs-app/\")){",
" pm.request.url = pm.request.url.toString().replace(\"nhs-app/\", \"nhs-app-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
Expand Down Expand Up @@ -57,6 +70,19 @@
],
"type": "text/javascript"
}
},
{
"listen": "prerequest",
"script": {
"exec": [
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"nhs-app/\")){",
" pm.request.url = pm.request.url.toString().replace(\"nhs-app/\", \"nhs-app-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
Expand Down Expand Up @@ -148,6 +174,12 @@
"var uniqueId = pm.variables.replaceIn('{{$guid}}');",
"eval(pm.globals.get(\"jsrsasign-js\")); //import jsrsasign lib",
"",
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"oauth2/\")){",
" pm.request.url = pm.request.url.toString().replace(\"oauth2/\", \"oauth2-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
"}",
"",
"var header = {",
" \"typ\": \"JWT\",",
" \"alg\": \"RS512\",",
Expand Down Expand Up @@ -242,6 +274,19 @@
],
"type": "text/javascript"
}
},
{
"listen": "prerequest",
"script": {
"exec": [
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"nhs-app/\")){",
" pm.request.url = pm.request.url.toString().replace(\"nhs-app/\", \"nhs-app-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
Expand Down Expand Up @@ -302,6 +347,19 @@
],
"type": "text/javascript"
}
},
{
"listen": "prerequest",
"script": {
"exec": [
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"nhs-app/\")){",
" pm.request.url = pm.request.url.toString().replace(\"nhs-app/\", \"nhs-app-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
Expand Down Expand Up @@ -362,6 +420,19 @@
],
"type": "text/javascript"
}
},
{
"listen": "prerequest",
"script": {
"exec": [
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"nhs-app/\")){",
" pm.request.url = pm.request.url.toString().replace(\"nhs-app/\", \"nhs-app-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
Expand Down Expand Up @@ -422,6 +493,19 @@
],
"type": "text/javascript"
}
},
{
"listen": "prerequest",
"script": {
"exec": [
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"nhs-app/\")){",
" pm.request.url = pm.request.url.toString().replace(\"nhs-app/\", \"nhs-app-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
Expand Down Expand Up @@ -480,6 +564,19 @@
],
"type": "text/javascript"
}
},
{
"listen": "prerequest",
"script": {
"exec": [
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"nhs-app/\")){",
" pm.request.url = pm.request.url.toString().replace(\"nhs-app/\", \"nhs-app-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
Expand Down Expand Up @@ -543,6 +640,19 @@
],
"type": "text/javascript"
}
},
{
"listen": "prerequest",
"script": {
"exec": [
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"nhs-app/\")){",
" pm.request.url = pm.request.url.toString().replace(\"nhs-app/\", \"nhs-app-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
Expand Down Expand Up @@ -606,6 +716,19 @@
],
"type": "text/javascript"
}
},
{
"listen": "prerequest",
"script": {
"exec": [
"var baseNhsAppApiUrl = pm.environment.get(\"base_url\").toString()",
"//replace base url for sandpit(dev) environment which uses dep api proxy(nhs-app-dep-dev)",
"if(baseNhsAppApiUrl.includes(\"dep.api\") && pm.request.url.toString().includes(\"nhs-app/\")){",
" pm.request.url = pm.request.url.toString().replace(\"nhs-app/\", \"nhs-app-dep/\").replace(\"{{base_url}}\", baseNhsAppApiUrl);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
Expand Down
12 changes: 6 additions & 6 deletions specification/nhs-app.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,11 @@ info:
After following these steps to create an application and register the public key, the App ID should be provided to the [NHS App onboarding team](mailto:app.onboarding@nhs.net) to grant your application permissions to the features that are appropriate to your use cases. If this step is not completed, all calls to this API will return responses with status code 403 Forbidden.

## Environments and testing
| API Environment | NHS Login Environment | Base URL |
| -------------------- | --------------------- | ------------------------------------------- |
| Development | Sandpit | `https://dev.api.service.nhs.uk/nhs-app/` |
| Integration Testing | Integration (AOS) | `https://int.api.service.nhs.uk/nhs-app/` |
| Production | Production | `https://api.service.nhs.uk/nhs-app/` |
| API Environment | NHS Login Environment | Base URL |
| -------------------- | --------------------- | ----------------------------------------------- |
| Development | Sandpit | `https://dep.api.service.nhs.uk/nhs-app-dep/` |
| Integration Testing | Integration (AOS) | `https://int.api.service.nhs.uk/nhs-app/` |
| Production | Production | `https://api.service.nhs.uk/nhs-app/` |

### Development
Our development environment:
Expand Down Expand Up @@ -146,7 +146,7 @@ x-spec-publication:
try-this-api:
disabled: true
servers:
- url: "https://dev.api.service.nhs.uk/nhs-app"
- url: "https://dep.api.service.nhs.uk/nhs-app-dep"
description: Development environment.
- url: "https://int.api.service.nhs.uk/nhs-app"
description: Integration test environment.
Expand Down