mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-02-06 11:23:48 -05:00
31 lines
1.4 KiB
HTML
31 lines
1.4 KiB
HTML
{% extends "base.html" %}
|
||
|
||
{% block per_page_title %}
|
||
Documentation
|
||
{% endblock %}
|
||
|
||
{% block content_column_content %}
|
||
|
||
<h1 class="font-body-2xl margin-bottom-3">Documentation</h1>
|
||
<p>This documentation is for developers who want to integrate the Notify.gov API with a web application or back office system.</p>
|
||
<h2 class="font-body-lg" id="client-libraries">Client libraries</h2>
|
||
<p>Links to documentation open in a new tab.</p>
|
||
<ul class="list list-bullet">
|
||
{% for key, label in [
|
||
('java', 'Java'),
|
||
('net', '.NET'),
|
||
('node', 'Node JS'),
|
||
('php', 'PHP'),
|
||
('python', 'Python'),
|
||
('ruby', 'Ruby'),
|
||
] %}
|
||
<li><a class="usa-link" 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 you’re using.</p>
|
||
<h2 class="font-body-lg" id="integrate-directly-with-the-api">Integrate directly with the API</h2>
|
||
<p>If you cannot use the client libraries, you can integrate directly with the API instead.</p>
|
||
<p>Read the <a class="usa-link" href="https://docs.notifications.service.gov.uk/rest-api.html" target="_blank" rel="noopener">REST API documentation</a> (this link opens in a new tab).</p>
|
||
|
||
{% endblock %}
|