Files
notifications-api/docs/api-usage.md
2022-11-17 10:57:34 -05:00

732 B

API Usage

Connecting to the API

To make life easier, the UK API client libraries are compatible with Notify.

For a usage example, see our Python demo.

An API key can be created at https://notifications-admin.app.cloud.gov/services/YOUR_SERVICE_ID/api/keys. However, in order to successfully send messages, you will need to receive a secret header token from the Notify team.

Using OpenAPI documentation

Retrieving a bearer token for use

On a mac, run

flask command create-admin-jwt | tail -n 1 | pbcopy

to copy a token usable by the admin UI to your pasteboard. This token will expire in 30 seconds