darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-07-13 09:50:39 -04:00
Code Issues Packages Projects Releases Wiki Activity

more docs

Browse Source
This commit is contained in:
stvnrlly
2022-10-26 15:45:45 +00:00
parent 38270c1c5c
commit 56329daa9a
6 changed files with 101 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api-usage.md Normal file
View File

@@ -0,0 +1,10 @@
# API Usage
## Connecting to the API
To make life easier, the [UK API client libraries](https://www.notifications.service.gov.uk/documentation) are compatible with Notify.
For a usage example, see [our Python demo](https://github.com/GSA/notify-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.