diff --git a/docs/index.md b/docs/index.md index 47b277bd0..28a0a755c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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

API keys

-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

Normal keys

@@ -141,13 +142,31 @@ Don’t use your normal key for automated testing.

Team keys

-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. +

Test keys

+ +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. + +

GOV.UK Notify API keys

+ +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 + + +

API endpoints

You can use the GOV.UK Notify API to: