darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-04-25 11:40:58 -04:00
Code Issues Packages Projects Releases Wiki Activity

Client libraries in plural throughout

Browse Source
This commit is contained in:
catherineheywood
2016-04-25 09:56:22 +01:00
parent 7b540fe10b
commit 614f0f7fb3
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/index.md
View File

@@ -70,7 +70,7 @@ There are two ways to integrate the API into your service:
* develop your own integration to produce requests in the correct format
GOV.UK Notify uses [JSON Web Tokens (JWT)](https://jwt.io/) for authentication and identification. The GOV.UK Notify client library encodes and decodes JSON Web 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 [JSON Web Tokens (JWT)](https://jwt.io/) for authentication and identification. The GOV.UK Notify client libraries encode and decode JSON Web Tokens when making requests to the GOV.UK Notify API. If you don’t use one of these libraries, you must manually create tokens yourself.
For examples of how to encode and decode JSON Web 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.
@@ -107,11 +107,13 @@ The signing algorithm is the HMAC signature, using the provided key SHA256 hashi
### API client libraries
GOV.UK Notify supports a python client library:
GOV.UK Notify supports the following client libraries:
[GOV.UK Notify Python client](https://github.com/alphagov/notifications-python-client)
* [GOV.UK Notify Python library](https://github.com/alphagov/notifications-python-client)
* [GOV.UK Notify PHP library] (https://github.com/alphagov/notifications-php-client)
* [GOV.UK Notify Java library] (https://github.com/alphagov/notifications-java-client)
This provides example code for calling the API and for constructing the API tokens.
These provide example code for calling the API and for constructing the API tokens.
### API endpoints
@@ -158,7 +160,7 @@ where:
* `to` is the phone number (required)
* `template` is the template ID to send (required)
**Note:** Access the template ID from the [GOV.UK Notify](https://www.notifications.service.gov.uk/) web application: go to **Text message templates** or **Email templates** and click on **API info**.
**Note:** To access the template ID from the [GOV.UK Notify](https://www.notifications.service.gov.uk/) web application: go to **Text message templates** or **Email templates** and click on **API info**.
* `personalisation` (optional) specifies the values for the placeholders in your templates