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

Update timings and direct integration content

Browse Source
This commit is contained in:
karlchillmaid
2019-08-21 09:56:27 +01:00
committed by GitHub
parent 3dfa6e06cc
commit 12f0c1e0ff
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
app/templates/views/documentation.html
View File

@@ -22,13 +22,13 @@
<li><a href="https://docs.notifications.service.gov.uk/{{ key }}.html" target="_blank" rel="noopener">{{ label }}</a></li>
{% endfor %}
</ul>
<p>A developer should be able to set up the API client and start sending test messages in around 30 minutes. A full integration might take a couple of days.</p>
<p>A developer should be able to set up the API client and start sending test messages in around 30 minutes. A full integration can take a few days, depending on the other systems you're using.</p>
<h2>Integrating directly with the API</h2>
<p>You can integrate directly with the Notify API.</p>
<p>To send a message you'll need to create an HTTPS request and add an authorisation header with your API key. The API key is encoded with JSON Web Tokens (JWT).</p>
<p>You should also read the client documentation to understand:</p>
<p>We recommend using our client documentation rather than integrating directly with the API.</p>
<p>There's no documentation for using the API in this way. You'll still need to read the client documentation to understand:</p>
<ul class="list list-bullet">
<li>what the API client does</li>
<li>what development work you'll need to do</li>
</ul>
<p>To send a message you'll need to create an HTTPS request and add an authorisation header with your API key. The API key is encoded with JSON Web Tokens (JWT).</p>
{% endblock %}