{"id":35405135,"url":"https://github.com/nhsdigital/nhs-notify-supplier-api","last_synced_at":"2026-04-22T16:02:39.894Z","repository":{"id":302643992,"uuid":"955850837","full_name":"NHSDigital/nhs-notify-supplier-api","owner":"NHSDigital","description":"API Definitions, Sandbox and SDK for the NHS Notify Supplier API","archived":false,"fork":false,"pushed_at":"2026-04-03T03:56:19.000Z","size":6725,"stargazers_count":3,"open_issues_count":24,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-03T06:48:33.583Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://nhsdigital.github.io/nhs-notify-supplier-api/","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NHSDigital.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2025-03-27T09:49:43.000Z","updated_at":"2026-04-02T10:41:52.000Z","dependencies_parsed_at":"2026-03-10T16:03:37.489Z","dependency_job_id":null,"html_url":"https://github.com/NHSDigital/nhs-notify-supplier-api","commit_stats":null,"previous_names":["nhsdigital/nhs-notify-supplier-api"],"tags_count":243,"template":false,"template_full_name":"NHSDigital/nhs-notify-repository-template","purl":"pkg:github/NHSDigital/nhs-notify-supplier-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fnhs-notify-supplier-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fnhs-notify-supplier-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fnhs-notify-supplier-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fnhs-notify-supplier-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NHSDigital","download_url":"https://codeload.github.com/NHSDigital/nhs-notify-supplier-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fnhs-notify-supplier-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31516839,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T03:10:19.677Z","status":"ssl_error","status_checked_at":"2026-04-07T03:10:13.982Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-02T12:42:07.255Z","updated_at":"2026-04-07T15:01:17.155Z","avatar_url":"https://github.com/NHSDigital.png","language":"TypeScript","readme":"# NHS Notify Supplier API\n\n[![1. CI/CD pull request](https://github.com/NHSDigital/nhs-notify-supplier-api/actions/workflows/cicd-1-pull-request.yaml/badge.svg)](https://github.com/NHSDigital/nhs-notify-supplier-api/actions/workflows/cicd-1-pull-request.yaml)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=NHSDigital_nhs-notify-supplier-api\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=NHSDigital_nhs-notify-supplier-api)\n\nThe NHS Notify Supplier API is intended primarily for print suppliers to integrate with the NHS Notify message request queueing system.\n\nIt models the concepts needed to configure production of letters and other printed materials to specific specifications, provide proofs of these materials, receive batch production requests, provide details of returned letters and correspondence, and to report on the status of these artifacts and associated management information such as volumes and associated costs.\n\nThis repository documents the Supplier API specification and provides an SDK with examples and reference client implementations for interacting with it.\n\n## OAS Specifications\n\n- [Current Version](specification/api/notify-supplier-phase1.yml)\n\n## Table of Contents\n\n- [NHS Notify Supplier API](#nhs-notify-supplier-api)\n  - [OAS Specifications](#oas-specifications)\n  - [Table of Contents](#table-of-contents)\n  - [API Consumers - Getting Started](#api-consumers---getting-started)\n    - [OAS Specification](#oas-specification)\n    - [Packages](#packages)\n    - [Documentation](#documentation)\n    - [SDK Assets](#sdk-assets)\n    - [Examples](#examples)\n  - [API Developers](#api-developers)\n    - [Setup](#setup)\n      - [Prerequisites and Configuration](#prerequisites-and-configuration)\n        - [SDKs](#sdks)\n    - [Build](#build)\n    - [Documentation](#documentation-1)\n    - [GitHub Actions CI/CD](#github-actions-cicd)\n      - [CI (Automatic)](#ci-automatic)\n      - [CD (Manual)](#cd-manual)\n  - [Licence](#licence)\n  - [Postman](#postman)\n\n## API Consumers - Getting Started\n\n### OAS Specification\n\n- Download the OAS Specification File from the [latest releases](https://github.com/NHSDigital/nhs-notify-supplier-api/releases)\n  - OAS JSON files `api-oas-specification-[Version].zip`\n\n### Packages\n\n- [NPM package](https://github.com/NHSDigital/nhs-notify-supplier-api/pkgs/npm/nhsnotifysupplier)\n\n### Documentation\n\n- View the [latest SDK documentation](https://nhsdigital.github.io/nhs-notify-supplier-api/)\n- Download local versions of the API docs from the [latest releases](https://github.com/NHSDigital/nhs-notify-supplier-api/releases)\n  - HTML `sdk-html-[Version].zip`\n  - Swagger `sdk-swagger-[Version].zip`\n\n### SDK Assets\n\nIf packages are unavailable the latest SDKs can be downloaded directly from:\n\n- Download SDKs from the [latest releases](https://github.com/NHSDigital/nhs-notify-supplier-api/releases)\n  - Python `sdk-python-[Version].zip`\n  - TypeScript `sdk-ts-[Version].zip`\n  - CSharp `sdk-csharp-[Version].zip`\n\n### Examples\n\nTODO:CCM-11209 Links to example clients.\n\n## API Developers\n\nNew developers of the NHS Notify Supplier API should understand the below.\n\n### Setup\n\n#### Prerequisites and Configuration\n\n- Utilised the devcontainer, for pre reqs and configuration.\n- You should open in a devcontainer or a Github workspaces.\n- By default it will run `make config` when the container is first setup\n\n##### SDKs\n\n- The [SDK](sdk) folder is excluded from all pre reqs\n- DO NOT make manual changes to the [SDK](sdk), instead [build](#build) it\n- The SDK folder is excluded from git commits,\n  and will be built as part of the CI/CD pipeline and released as a GitHub\n  release.\n\n### Build\n\nTo generate the SDK folder from changes to the [specification/api/notify-supplier.yml](specification/api/notify-supplier.yml) OAS specification:\n\n```bash\nmake clean\nmake build\n```\n\nThis will generate:\n\n- Python SDK\n- TypeScript SDK\n- HTML Docs\n\nTo view HTML docs:\n\n```bash\nmake serve\n```\n\nby default they will be available at [http://localhost:3050](http://localhost:3050)\n\nThese are generated using [https://hub.docker.com/r/openapitools/openapi-generator-cli](https://hub.docker.com/r/openapitools/openapi-generator-cli)\n\n### Documentation\n\n- You can preview the OAS locally by running `make serve-oas`\n\n### GitHub Actions CI/CD\n\n#### CI (Automatic)\n\nPRs will run the [CI workflow](https://github.com/NHSDigital/nhs-notify-supplier-api/actions/workflows/cicd-1-pull-request.yaml)\nfor testing.\n\nPRs that are merged to main will run the same [CI workflow](https://github.com/NHSDigital/nhs-notify-supplier-api/actions/workflows/cicd-1-pull-request.yaml)\nwill generate a\n[pre-release](https://github.com/NHSDigital/nhs-notify-supplier-api/releases)\nbased on the date and the commit hash.\n\n#### CD (Manual)\n\nDeployments can be made of any [release](https://github.com/NHSDigital/nhs-notify-supplier-api/releases)\n(including the GitHub pages) by running the CD pipeline\n[cicd-3-deploy.yaml](https://github.com/NHSDigital/nhs-notify-supplier-api/actions/workflows/cicd-3-deploy.yaml)\n\n## Licence\n\nUnless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.\n\nAny HTML or Markdown documentation is [© Crown Copyright](https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/) and available under the terms of the [Open Government Licence v3.0](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/).\n\n## Postman\n\nIncluded in this repo are postman collections that allows the user to interact with the sandbox APIs.\n\nTo use the collections:\n\nDownload the json files located in the postman directory\nImport the files into postman\nSelect a target environment in postman\nRun the collection\nThe collections must be kept in sync manually\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhsdigital%2Fnhs-notify-supplier-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnhsdigital%2Fnhs-notify-supplier-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhsdigital%2Fnhs-notify-supplier-api/lists"}