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

add info about keys

Browse Source
This commit is contained in:
Catherine Heywood
2016-07-11 14:41:20 +01:00
parent 5fed199696
commit fc3d155f3b
1 changed files with 37 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
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_integ](#Testing your integration with GOV.UK Notify)
* [API_keys](#API keys)
* [API endpoints](#API_endpoints)
* [Send notifications: POST](#sendnotifications)
* [Retrieve notifications: GET](#getnotifications)
@@ -111,6 +113,41 @@ 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">Testing 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 types of API key that you can create within GOV.UK Notify are:
* normal key
* team key
<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 only send 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 a team key 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.
<h2 id="API_endpoints">API endpoints</h2>
You can use the GOV.UK Notify API to: