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

Doc tweaks

Browse Source
This commit is contained in:
catherineheywood
2016-04-12 16:35:10 +01:00
parent 8e98f3cf43
commit 727cb49f23
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/index.md
View File

@@ -69,13 +69,14 @@ A JWT token contains, in encrypted format:
Use the [GOV.UK Notify](https://www.notifications.service.gov.uk/) web application to find your service ID and create API keys.
See [authentication.py](https://github.com/alphagov/notifications-python-client/blob/master/notifications_python_client/authentication.py) in the GOV.UK Notify Python client library for sample code to encode and decode JWT tokens.
**Important:** API keys are secret, so save them somewhere safe. Do not commit API keys to public source code repositories.
For examples of how to encode and decode JWT tokens, see [authentication.py](https://github.com/alphagov/notifications-python-client/blob/master/notifications_python_client/authentication.py) in the GOV.UK Notify Python client library.
JWT tokens
-----------------------------------------
------------
JWT tokens have a series of standard and application-specific claims.
@@ -97,7 +98,7 @@ GOV.UK Notify application-specific claims:
}
```
GOV.UK Notify API tokens sign the:
The GOV.UK Notify API tokens sign the:
* request being made
* payload (for POST requests)