darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-02-05 19:03:30 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #776 from alphagov/keys

Browse Source 
Keys
This commit is contained in:
catherineheywood
2016-07-12 08:34:20 +01:00
committed by GitHub
parent d33c254fa5 f17675155b
commit dd0ff77c83
1 changed files with 55 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
docs/index.md
View File

@@ -8,6 +8,8 @@ This document is for central government developers and technical architects who
* [Authenticate requests](#AuthRequests)
* [JSON Web Tokens: claims](#JWT_claims)
* [API client libraries](#client_libraries)
* [Test your integration with GOV.UK Notify](#test_integ)
* [API keys](#API_keys)
* [API endpoints](#API_endpoints)
* [Send notifications: POST](#sendnotifications)
* [Retrieve notifications: GET](#getnotifications)
@@ -21,12 +23,12 @@ This document is for central government developers and technical architects who
GOV.UK Notify is a cross-government platform that lets government services send notifications by text or email. It's currently in beta.
There are 2 ways to send notifications:
To send notifications you can:
* use the [GOV.UK Notify](https://www.notifications.service.gov.uk/) web application
* [integrate your web applications or back office systems](#integrate_Notify) with the GOV.UK Notify API
The GOV.UK Notify allows you to [send notifications (POST)](#sendnotifications) and [get the status of notifications (GET)](#getnotifications) you have sent.
The GOV.UK Notify API allows you to [send notifications (POST)](#sendnotifications) and [get the status of notifications (GET)](#getnotifications) you have sent.
To find out more about GOV.UK Notify, see the [Government as a Platform](https://governmentasaplatform.blog.gov.uk/) blog.
@@ -46,7 +48,7 @@ To find out more about GOV.UK Notify, see the [Government as a Platform](https:/
>
> Your ((item)) is due for renewal on ((date)).
3. Create an API key. This will be used to connect to the GOV.UK Notify API.
3. Create an [API key](#API_keys). This will be used to connect to the GOV.UK Notify API.
Each service can have multiple API keys. This allows you to integrate several systems, each with its own key. You can also have separate keys for your development and test environments.
@@ -111,6 +113,56 @@ GOV.UK Notify supports the following client libraries:
These provide example code for calling the API and for creating API tokens.
<h2 id="test_integ">Test your integration with GOV.UK Notify</h2>
Service teams should do all their testing within the GOV.UK Notify production environment (https://api.notifications.service.gov.uk).
You don’t need different service accounts or environments. Instead, there are 3 types of API key that let you do functional and performance integration testing.
<h3 id="API_keys">API keys</h3>
The 3 types of API key that you can create within GOV.UK Notify are:
* [normal keys](#normal_keys)
* [team keys](#team_keys)
* [test keys](#test_keys)
Type of key | Sends real messages? | Appears in activity and statistics? | Daily service limit
--- | --- | --- | ---
Normal key | Yes | Yes | 50 (trial), unlimited (live)
Team key | Yes (only to team members) | Yes | 50 (trial), unlimited (live)
Test key | No | No | Unlimited
<h4 id="normal_keys">Normal keys</h3>
Normal keys have the same permissions as the service:
* when the service is in trial mode, you can send only to members of your team and you are restricted to 50 messages per day
* when the service is live, you can use the key to send messages to anyone
Messages sent with a normal key show up on your dashboard and count against your text message and email allowances.
There is no need to generate a new key when the service moves from trial to live.
Don’t use your normal key for automated testing.
<h4 id="team_keys">Team keys</h3>
Use team keys for end-to-end functional testing.
A team key lets you send real messages to members of your team. You get an error if you try to send messages to anyone else.
Messages sent with a team key show up on your dashboard and count against your text message and email allowances.
<h4 id="test_keys">Test keys</h3>
Use test keys to test the performance of your service and its integration with GOV.UK Notify under load.
Test keys don’t send real messages but they do generate realistic responses. There’s no restriction on who you can send to or how many messages you can send per day.
Messages sent using a test key don’t show up on your dashboard or count against your text message and email allowances.
<h2 id="API_endpoints">API endpoints</h2>
You can use the GOV.UK Notify API to: