diff --git a/docs/index.md b/docs/index.md index 1b8ecde51..439318fc5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -50,7 +50,9 @@ To get started: 6. If you intend to use the GOV.UK Notify API, create a new API key. This will be used to connect to the GOV.UK Notify API. - You can provide all your developers with keys so they can experiment in the Sandbox environment. But keep the number of keys for real integrations to a minimum number of people on your team. + Each service can have multiple API keys. This allows you to integrate a number of systems, each with its own key. You can also have separate keys for your development and test environments. + + **Important:** API keys are secret, so save them somewhere safe. Do not commit API keys to public source code repositories. ## Integrate the GOV.UK Notify API into your service @@ -65,10 +67,12 @@ There are two ways to integrate the API into your service: * use one of the client libraries provided by GOV.UK Notify: - * [Python library](https://github.com/alphagov/notifications-python-client) - * [PHP library] (https://github.com/alphagov/notifications-php-client) - * [Java library] (https://github.com/alphagov/notifications-java-client) - +
Note: To access the template ID from the [GOV.UK Notify](https://www.notifications.service.gov.uk/) web application, go to Text message templates or Email templates and click on API info. +
+ * `personalisation` (optional) specifies the values for the placeholders in your templates - **Note:** You must provide all placeholders set up in your template. See [how to create placeholders in a template](#quickstart). + +Note: You must provide all placeholders set up in your template. See [how to create placeholders in a template](#quickstart). The response will be: