API Consumers - Getting Started

Known Issues / Todo

⛅ This page is draft and is subject to rapid change, and may not be fully accurate or complete

Integration Guide

The primary resource for integrating and onboarding with the NHS Notify Supplier API can be found within the Integration Guide

The OAS defines the scope, behaviour, and interactions with the Supplier API.

Released versions of the specification can be found within latest releases:

api-oas-specification-[version].zip

If you have installed the local repository requirements or are utilising the devcontainer, you can build/serve the documentation locally:

- make bundle-oas
- make serve-oas

This documentation is maintained within the /docs folder of the repository and published to GitHub pages on PR merge

SDKs are generated for Python, TypeScript and C# using @openapitools

If packages are not available, then SDKs can be downloaded directly from latest releases:

- Python sdk-python-[Version].zip
- TypeScript sdk-ts-[Version].zip
- CSharp sdk-csharp-[Version].zip

An NPM nhsnotifysupplier package is published on pre-releases and releases

A sandbox environment is available to aid in discovery and development of your integration.

It will provide limited, fixed responses and does not require authentication to use.

There are two ways to access the sandbox:

You can build the sandbox locally by installing the repository requirements (or using the devcontainer) and running:

make generate-sandbox