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 changes

Browse Source 
Make it clearer what placeholders are. 
Make it clearer you need to add a template even if using API.
Remove 'empty' sections.
Other minor changes.
This commit is contained in:
catherineheywood
2016-04-14 10:57:37 +01:00
parent cfe27d1f75
commit 9197ed0b1a
1 changed files with 17 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
docs/index.md
View File

@@ -1,15 +1,15 @@
About this document
==========================
This document is for public sector [?] developers, technical architects, and service managers who want to use the GOV.UK Notify platform to send notifications to users of their digital service.
This document is for central government 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.
GOV.UK Notify is a cross-government platform, currently in beta, that lets government services send notifications by sms or email.
There are two ways to send notifications:
* use the [GOV.UK Notify](https://www.notifications.service.gov.uk/) web application
* [integrate your web applications or back office systems](#integrateNotify) with the GOV.UK Notify API
* [integrate your web applications or back office systems](#integrateNotify) with the GOV.UK Notify API
To find out more about GOV.UK Notify, see the [Government as a Platform](https://governmentasaplatform.blog.gov.uk/) blog.
@@ -22,6 +22,7 @@ To use GOV.UK Notify, you need:
* a mobile number for 2-factor authentication
<a name="quickstart"></a>
Quick start guide to GOV.UK Notify
===================================
@@ -32,15 +33,19 @@ To get started:
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.
3. Add a template so you can send sms and email notifications. You can personalise the template using double brackets for variables. For example:
3. Add a template so you can send sms and email notifications.
**Note:** A template is required even if you send notifications by integrating with the GOV.UK Notify API.
You can personalise the template using double brackets for placeholders. For example:
Dear ((name)),
Your ((item)) is due for renewal on ((date)).
4. Upload a csv file containing a header row matching the variables in your template, and data rows with values to use for the variables.
4. You can upload a csv file containing a header row matching the placeholders in your template, and data rows with values to use for the placeholders.
5. Send an sms or email notification.
6. Create a new API key. This will be used to connect to the API.
6. If you intend to use the GOV.UK Notify API, create a new API key. This will be used to connect to the GOV.UK Notify 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.
@@ -85,6 +90,7 @@ JSON Web Token standard claims:
"alg": "HS256"
}
```
[on the JWT website `type` and `alg` are the other way round. Does it matter?]
GOV.UK Notify application-specific claims:
```
@@ -161,7 +167,11 @@ POST /notifications/email
where:
* `to` is the phone number (required)
* `template` is the template ID to send (required)
* `personalisation` (optional) specifies the values to be used in your templates
* `personalisation` (optional) specifies the values for the placeholders in your templates
You must provide all placeholders set up in your template. See [how to create placeholders in a template](#quickstart)
[is the above correct?]
<a id="coderesponse"></a>
The response will be:
@@ -261,19 +271,6 @@ The GOV.UK Notify API code is open sourced at:
Functional testing
---------------------
[Some info in Rosalie’s notes.]
Security
----------
[Some info in Rosalie’s notes.]
Privacy
--------