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

Move link to authentication.py file

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

8
docs/index.md
View File

@@ -59,7 +59,9 @@ There are two ways to integrate the API into your service:
* use a client library provided by GOV.UK Notify - there is currently a [python library](https://github.com/alphagov/notifications-python-client) and 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. GOV.UK Notify client library encodes and decodes JWT tokens when making requests to the GOV.UK Notify API. If you don't use this library, you must manually create tokens yourself.
GOV.UK Notify uses [JWT tokens](https://jwt.io/) for authentication and identification. The GOV.UK Notify client library encodes and decodes JWT tokens when making requests to the GOV.UK Notify API. If you don't use this library, you must manually create tokens yourself.
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.
A JWT token contains, in encrypted format:
* your service ID - identifies your service
@@ -71,10 +73,6 @@ 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.
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
------------