darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-05-05 16:38:59 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add Test key

Browse Source
This commit is contained in:
Catherine Heywood
2016-07-11 14:55:11 +01:00
parent fc3d155f3b
commit d1e885954b
1 changed files with 23 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/index.md
View File

@@ -8,8 +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)
* [Testing your integration with GOV.UK Notify](#test_integ)
* [API keys](#API_keys)
* [API endpoints](#API_endpoints)
* [Send notifications: POST](#sendnotifications)
* [Retrieve notifications: GET](#getnotifications)
@@ -121,10 +121,11 @@ You don’t need different service accounts or environments. Instead, there are
<h3 id="API_keys">API keys</h3>
The types of API key that you can create within GOV.UK Notify are:
The 3 types of API key that you can create within GOV.UK Notify are:
* normal key
* team key
* team key
<h4 id="normal_keys">Normal keys</h3>
@@ -141,13 +142,31 @@ 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.
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 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.
<h4 id="summary_keys">GOV.UK Notify API keys</h3>
Sends real messages? | Appears in activity and statistics? | Daily service limit
--- | --- | ---
Normal key | Yes | Yes | 50 (trial) Unlimited (live)
Team key | Yes (only team members) | Yes | 50 (trial) Unlimited (live)
Test key | No | No | Unlimited
<h2 id="API_endpoints">API endpoints</h2>
You can use the GOV.UK Notify API to: