7.0 KiB
About this document
This document is for developers, technical architects, and service managers who want to use the GOV.UK Notify platform to send notifications to users of their digital service.
About GOV.UK Notify
GOV.UK Notify is a cross-government platform, currently in beta, that lets government services and agencies [?] send notifications by sms or email.
There are two ways to send notifications:
- use the GOV.UK Notify web application
- integrate your web applications or back office systems with the GOV.UK Notify API
To find out more about GOV.UK Notify, see the Government as a Platform blog.
Before you start
To use GOV.UK Notify, you need:
- an email address from a local or central government organisation
- a mobile number for 2-factor authentication
Quick start guide to GOV.UK Notify
To get started:
- Register for a GOV.UK Notify account. You will need your mobile phone for 2-factor authentication.
- Add a new service.
At first your service will be in trial mode. In trial mode you will only be able to send test sms and email notifications to your own mobile number or email address. When you’re fully integrated and ready to go live, send a request to the GOV.UK Notify team.
- Add a template so you can send sms and email notifications. You can personalise the template using double brackets for replaceables. For example:
Dear ((name))
Your ((item)) will expire on ((date)).
- Upload a csv file containing a header row with the replaceables in your template, and data rows with values for the replaceables.
- Send an sms or email notification.
- Create a new API key. This will be used to connect to the API.
You can provide all your developers with test keys so they can experiment in the Sandbox environment. But keep the number of keys for real integrations to a minimum number of people on your team.
Integrate the GOV.UK 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.
API integration
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
- develop your own integration to produce requests in the correct format
GOV.UK.Notify uses JWT tokens 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.
A JWT token contains, in encrypted format:
- your service ID - identifies your service
- your API key (in JWT token terms this is called the client ID) - used to create an individual request for an API resource [change to: used to sign tokens during requests for API resources??]
- an indication of what you're trying to do - GET, POST, etc.
- the endpoint you're trying to access
Use the GOV.UK Notify web application to find your service ID and create API keys.
Important: API keys are secret, so save them somewhere safe. Do not commit API keys to public source code repositories.
[Information below needs to be expanded]
JWT tokens have a series of standard and application-specific claims.
GOV.UK Notify standard claims:
{
"typ": "JWT",
"alg": "HS256"
}
GOV.UK Notify application-specific claims:
{
iss: 'string', // service id
iat: 0, // creation time in epoch seconds (UTC)
req: 'string', // signed request
pay: 'string', // signed payload (POST requests only)
}
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.
Request signing is of the form HTTP METHOD PATH.
GET /notification/1234
Payload signing requires the actual payload to be signed, NOT the JSON object. Serialize the object first then sign the serialized object.
API endpoints
You can use the API to:
- send a notification
- retrieve one notification
- retrieve all notifications
To send a text notification:
POST /notifications/sms
{
'to': '+447700900404',
'template': 1,
'personalisation': {
'name': 'myname',
'date': '2016'
}
}
To send an email notification:
POST /notifications/email
{
'to': 'email@gov.uk',
'template': 1,
'personalisation': {
'name': 'myname',
'date': '2016'
}
}
where:
- ‘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?]
The response will be:
{
'data':{
'notification': {
'id':1
}
}
}
To retrieve the status of a single text or email notification:
GET /notifications/{id}
{
'data':{
'notification': {
'status':'sent',
'createdAt':'2016-01-01T09:00:00.999999Z',
'to':'+447827992607',
'method':'sms',
'sentAt':'2016-01-01T09:01:00.999999Z',
'id':1,
'message':'...',
'job_id':1,
'sender':'sms-partner'
}
}
}
where
- ‘status’ is the the status of the notification.
- 'status' can be 'sending', 'delivered', 'failed' [change status in message above?]
- 'method' is 'sms' or 'email'
- 'job_id' is the unique identifier for the process of sending [change to retrieving?] the notification
- 'message' is the content of message
- 'sender' may be the provider [?]
The above fields are populated once the message has been processed; initially you get back the response indicated above.
To get the status of all notifications:
GET /notifications
{
'data':[{
'notification': {
'status':'sent',
'createdAt':'2016-01-01T09:00:00.999999Z',
'to':'+447827992607',
'method':'sms',
'sentAt':'2016-01-01T09:01:00.999999Z',
'id':1,
'message':'...',
'jobId':1,
'sender':'sms-partner'
}
},
{
'notification': {
'status':'sent',
'createdAt':'2016-01-01T09:00:00.999999Z',
'to':'+447827992607',
'method':'email',
'sentAt':'2016-01-01T09:01:00.999999Z',
'id':1,
'message':'...',
'jobId':1,
'sender':'email-partner'
}
}...]
}
This list is split into pages. To scroll through the pages run:
GET /notifications?&page=2
Functional testing
[Some info in Rosalie’s notes.]
Security
[Some info in Rosalie’s notes.]
Privacy
[you just have to do get service, it returns id]