diff --git a/docs/index.md b/docs/index.md index 6b61b15f7..19fc2e863 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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. +