NHS Notify Supplier API Home Page
Welcome to the NHS Notify Supplier API repository. This project provides a set of APIs and supporting documentation to allow communication suppliers to integrate with the NHS Notify service.
Using this Documentation
Who/what is this repository is for?
- NHS Developers working on NHS Notify Supplier API
- Suppliers who seek resources to support their integration with the NHS Notify Supplier API
- Those who are interested in NHS Notify architecture and how it is actively developed
Who/what is this repository not for?
- Those who wish to send communications through NHS Notify
What this repo contains
- High level developer documentation for source code location, and build process.
- The NHS Notify Supplier Open API Specification
- The implementation of the API AWS backend and related Infrastructure as Code
- Onboarding guidance documentation and supporting integration materials
What this repo does not contain
- Any configuration details of the Deployment phases or infrastructure of the Supplier API.
- The generation of letters or their allocation to suppliers
Table of Contents
API Status
This API is in-development.
This API is being made available to support testing and integration, but may receive breaking changes based on feedback.
Open API Specification
The API is defined through an Open API Specification .yml file.
The next version of the specification file is found within /specifications
Released versions of the specification can be found within latest releases
Related Repos
API Consumers
If you wish to integrate with the Supplier API refer to the API Consumer pages and Getting Started as an API Consumer
You may also find it helpful to refer to the Specification
API Developers
For NHS Developers working on the Supplier API refer to the API Developer pages and Getting Started as an API Developer
Contributing
For guidance on contributing to this documentation or this repository please refer to Contributing
Support
For questions or support, please raise an issue in this repository or contact the NHS Notify team.
Licence
Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.
Any HTML or Markdown documentation is © Crown Copyright and available under the terms of the Open Government Licence v3.0.