Merge pull request #3096 from alphagov/documentation-content-update

Update Documentation content
This commit is contained in:
karlchillmaid
2019-08-21 14:33:37 +01:00
committed by GitHub

View File

@@ -7,9 +7,9 @@
{% block content_column_content %}
<h1 class="heading-large">Documentation</h1>
<p>Use the GOV.UK Notify API to send messages automatically.</p>
<h2 class="heading-medium">Clients</h2>
<p>Choose a client to integrate our API with your web application or back-office system. Links to documentation open in a new tab.</p>
<p>This documentation is for developers who want to integrate the GOV.UK Notify API with a web application or back office system.</p>
<h2 class="heading-medium">Client libraries</h2>
<p>Links to documentation open in a new tab.</p>
<ul class="list list-bullet">
{% for key, label in [
('java', 'Java'),
@@ -22,5 +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 can take a few days, depending on the other systems youre using.</p>
<h2>Integrating directly with the API</h2>
<p>We recommend using the client libraries rather than integrating directly with the API.</p>
<p>Theres no documentation for using the API in this way. Youll 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 youll need to do</li>
</ul>
<p>To send a message youll 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 %}