darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-09-08 08:28:15 -04:00
Code Issues Packages Projects Releases Wiki Activity

Doc tweaks

Browse Source
This commit is contained in:
catherineheywood
2016-04-12 13:31:56 +01:00
parent 0f9174f06e
commit f56ac2b63e
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/index.md
View File

@@ -48,7 +48,7 @@ To get started:
Integrate the GOV.UK Notify API into your service Integrate the GOV.UK Notify API into your service
=================================================== ===================================================
GOV.UK.Notify provides an API that allows you to create text and email notifications and get the status of notifications you have sent. GOV.UK Notify provides an API that allows you to create text and email notifications and get the status of notifications you have sent.
API integration API integration
------------------ ------------------
@@ -59,7 +59,7 @@ 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 * 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 * 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 tokens yourself. 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 tokens yourself.
A JWT token contains, in encrypted format: A JWT token contains, in encrypted format:
* your service ID - identifies your service * your service ID - identifies your service
@@ -155,9 +155,9 @@ POST /notifications/email
``` ```
where: where:
* 'to' is the phone number (required) * `to` is the phone number (required)
* ‘template’ is the template ID to send (required) * `template` is the template ID to send (required)
* ‘personalisation‘ (optional) specifies the replaceables [where do these come from, the csv file?] * `personalisation` (optional) specifies the replaceables [where do these come from, the csv file?]
<a id="coderesponse"></a> <a id="coderesponse"></a>
The response will be: The response will be:
@@ -194,11 +194,11 @@ GET /notifications/{id}
} }
``` ```
where: where:
* ‘status’ is the the status of the notification; this can be 'sending', 'delivered', 'failed' [change status in message above?] * `status` is the the status of the notification; this can be `sending`, `delivered`, `failed` [change status in message above?]
* 'method' is 'sms' or 'email' * `method` is `sms` or `email`
* 'job_id' is the unique identifier for the process of sending [change to retrieving?] the notification * `job_id` is the unique identifier for the process of sending [change to retrieving?] the notification
* 'message' is the content of message * `message` is the content of message
* 'sender' may be the provider [?] * `sender` may be the provider [?]
The above fields are populated once the message has been processed; initially you get back the [response](#coderesponse) indicated above. The above fields are populated once the message has been processed; initially you get back the [response](#coderesponse) indicated above.