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

Merge pull request #382 from alphagov/docs-tweaks

Browse Source 
Some proposed changes to the docs
This commit is contained in:
catherineheywood
2016-04-06 09:07:24 +01:00
parent e85e68bc64 c6bb4d11a3
commit bcad27ed83
1 changed files with 18 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/index.md
View File

@@ -8,7 +8,7 @@ GOV.UK Notify is a cross-government platform, currently in beta, that lets gover
There are two ways to send notifications: There are two ways to send notifications:
* use the GOV.UK Notify interface * use the [GOV.UK Notify](https://www.notifications.service.gov.uk/) web application
* integrate your web applications or back office systems with the GOV.UK Notify API * 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](https://governmentasaplatform.blog.gov.uk/) blog. To find out more about GOV.UK Notify, see the [Government as a Platform](https://governmentasaplatform.blog.gov.uk/) blog.
@@ -30,7 +30,7 @@ To get started:
1. Register for a [GOV.UK Notify](https://www.notifications.service.gov.uk/) account. You will need your mobile phone for 2-factor authentication. 1. Register for a [GOV.UK Notify](https://www.notifications.service.gov.uk/) account. You will need your mobile phone for 2-factor authentication.
2. Add a new service. 2. Add a new service.
At first your service will be in trial mode. When you’re fully integrated and ready to go live, send a request to the GOV.UK Notify team. 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 replaceables. For example: 3. Add a template so you can send sms and email notifications. You can personalise the template using double brackets for replaceables. For example:
@@ -38,7 +38,7 @@ To get started:
Your ((item)) will expire on ((date)). Your ((item)) will expire on ((date)).
4. Upload a csv file containing the list of recipients and replaceables. 4. Upload a csv file containing a header row that corresponds to the replaceables in your template, and data rows with the values for substituting the replaceables.
5. Send an sms or email notification. 5. Send an sms or email notification.
6. Create a new API key. This will be used to connect to the API. 6. Create a new API key. This will be used to connect to the API.
@@ -56,10 +56,11 @@ You can either:
* use a client library provided by Notify - there is currently 1 python library but more will be added in different languages * use a client library provided by Notify - there is currently 1 python library but more will be added in different languages
* develop your own [???] * develop your own [???]
To make an IPA call to a client you need: To make an API call to a client you need:
* the service ID - this is aviailable under API keys on the GOV.UK Notify interface * the service ID - this is aviailable under API keys on the [GOV.UK Notify](https://www.notifications.service.gov.uk/) web application
* an API key - this is a secret key so save it somewhere safe; do not commit API keys to public source code repositories * an API key - this is a secret key so save it somewhere safe; do not commit API keys to public source code repositories
API integration API integration
------------------ ------------------