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

Updates to the integration_testing documentation.

Browse Source 
Added a link to this doc in the documentation page.
This commit is contained in:
Rebecca Law
2017-02-01 10:27:02 +00:00
parent 7f31bd7548
commit e929088bea
2 changed files with 30 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
app/templates/views/integration_testing.html
View File

@@ -11,15 +11,15 @@
<h1 class="heading-large">Integration testing</h1>
<p>
Service teams should do all their testing within the GOV.UK Notify production environment (https://api.notifications.service.gov.uk).
Service teams should do all their testing within the GOV.UK Notify production environment, https://api.notifications.service.gov.uk.
</p>
<p>
You don’t need different Notify accounts or access to other Notify environments. Instead, there are different types of API key that let you do functional or performance integration testing.
You don’t need different Notify accounts or access to other Notify environments. Instead, there are different types of API keys that let you do functional or performance integration testing.
</p>
<h2 class="heading-medium">API Keys</h2>
<h2 class="heading-medium">Types of API Keys</h2>
<p>
The 3 types of API key that you can create within GOV.UK Notify are:
There are 3 types of API key available within GOV.UK Notify:
</p>
<ul class="list list-bullet">
<li>live key - “Send messages to anyone”</li>
@@ -35,7 +35,7 @@
Messages sent with a live key show up on your dashboard and count against your text message and email allowances.
</p>
<p>
You should plan to rotate these keys on a regular basis. You may have more than one active key at a time. To revoke the key simply click the revoke button on the API Key page.
You should plan to rotate these keys on a regular basis. You may have more than one active key at a time. To revoke the key click the revoke button on the API Key page.
</p>
<h2 class="heading-medium">Team key</h2>
@@ -43,7 +43,7 @@
Use a team key for end-to-end functional testing.
</p>
<p>
A team key lets you send real messages to members of your team (and addresses/numbers that you have added to your whitelist). You will get an error if you use these keys to send messages to anyone else.
A team key lets you send real messages to members of your team and addresses/numbers that you have added to your whitelist. You will get an error if you use these keys to send messages to anyone else.
</p>
<p>
Messages sent with a team key show up on your dashboard and count against your text message and email allowances.
@@ -54,7 +54,7 @@
Use a test key to test the performance of your service and its integration with GOV.UK Notify under load.
</p>
<p>
A test key doesn’t send real messages but generates realistic responses. There’s no restriction on who you can send to or how many messages you can send per day.
Test keys don’t send real messages but do generates realistic responses. There’s no restriction on who you can send to or how many messages you can send per day.
</p>
<p>
Messages sent using a test key don’t show up on your dashboard or count against your text message and email allowances.
@@ -70,6 +70,28 @@
<li>"temp-fail@simulator.notify" => temporary failure</li>
<li>"perm-fail@simulator.notify" => permanent failure</li>
</p>
<h2 class="heading-medium">Smoke testing your integration</h2>
<p>
If you need to smoke test your integration with Notify on a regular basis, you should use the smoke test numbers and addresses below.
</p>
<p>
The smoke test numbers and addresses will immediately return a successful response, but won’t send a real message and won’t produce a delivery receipt.
</p>
<p>
You can use the smoke test numbers and addresses with any type of key.
</p>
<p>
If your smoke tests need to fetch a delivery receipt, then use a test key - and don’t use these numbers and addresses.
<li>“07700900000”</li>
<li>“07700900111”</li>
<li>“07700900222”</li>
<li>“simulate-delivered@notifications.service.gov.uk”</li>
<li>“simulate-delivered-2@notifications.service.gov.uk”</li>
<li>“simulate-delivered-3@notifications.service.gov.uk”</li>
</p>
</div>
</div>