darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-02-04 18:32:33 -05:00
Code Issues Packages Projects Releases Wiki Activity

Bring sections over from existing doc, to rework

Browse Source
This commit is contained in:
catherineheywood
2016-04-12 09:58:09 +01:00
parent eb2ea7ce92
commit faedb3d7be
1 changed files with 21 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/index.md
View File

@@ -56,7 +56,7 @@ API integration
![Notfy](Notify.png)
There are two ways to integrate the API into your service:
* use a client library provided by Notify - there is currently 1 python library but more will be added in different languages
* use a client library provided by GOV.UK Notify - there is currently a [python library](https://github.com/alphagov/notifications-python-client) but more will be added in different languages
* develop your own integration to produce requests in the correct format
GOV.UK.Notify uses [JWT tokens](https://jwt.io/) for authentication and identification. JWT tokens are built into the GOV.UK Notify client library. If you don't use this library, you must manually create the token yourself.
@@ -71,6 +71,16 @@ Use the [GOV.UK Notify](https://www.notifications.service.gov.uk/) web applicati
**Important:** API keys are secret, so save them somewhere safe. Do not commit API keys to public source code repositories.
API client libraries
------------------
GOV.UK Notify supports a python client library:
[GOV.UK Notify Python client](https://github.com/alphagov/notifications-python-client)
This provides example code for calling the API and for constructing the API tokens [are they not built in?].
[Information below needs to be expanded]
JWT tokens have a series of standard and application-specific claims.
@@ -93,7 +103,7 @@ GOV.UK Notify application-specific claims:
}
```
Notify API tokens sign both the request being made, and for POST requests, the payload.
GOV.UK Notify API tokens sign both the request being made, and for POST requests, the payload.
The signing algorithm is HMAC signature, using provided key SHA256 hashing algorithm.
@@ -145,7 +155,7 @@ POST /notifications/email
```
where:
* ‘to’ is the phone number (required)
* 'to' is the phone number (required)
* ‘template’ is the template ID to send (required)
* ‘personalisation‘ (optional) specifies the replaceables [where do these come from, the csv file?]
@@ -235,6 +245,14 @@ GET /notifications?&page=2
```
GOV.UK Notify API code
Notify API code is open sourced at:
[GOV.UK Notify API](https://github.com/alphagov/notifications-api)
Functional testing
---------------------