mirror of
https://github.com/GSA/notifications-admin.git
synced 2025-12-11 07:33:36 -05:00
6f5750f095
* Removed all govuk css * Updated reference files * Removing govuk js * Fixed casing for modules, removed unused page * Got more reference images * Updated template page * Removed govuk padding util * Updated hint to uswds hint * More govuk cleanup * Commiting backstopjs ref files * Fixed all unit tests that broke due to brittleness around govuk styling * Added new ref images * Final removal of govuk * Officially removed all govuk references * Updated reference file * Updated link to button * UI modernization * Cleanup * removed govuk escaping tests since they are no longer needed * Fix CodeQL security issue in escapeElementName function - Escape backslashes first before other special characters - Prevents potential double-escaping vulnerability - Addresses CodeQL alert about improper string escaping * Found more govuk removal. Fixed unit tests * Add missing pipeline check to pre-commit * updated test * Updated e2e test * More update to e2e test * Fixed another e2e test * Simple PR comments addressed * More updates * Updated backstop ref files * Refactored folder selection for non-admins * Updated redundant line * Updated tests to include correct mocks * Added more ref files * Addressing carlos comments * Addressing Carlo comments, cleanup of window initing * More cleanup and addressing carlo comments * Fixing a11 scan * Fixed a few issues with javascript * Fixed for pr * Fixing e2e tests * Tweaking e2e test * Added more ref files and cleaned up urls.js * Fixed bug with creating new template * Removed brittle test - addressed code ql comment * e2e race condition fix * More e2e test fixes * Updated e2e tests to not wait for text sent * Updated test to not wait for button click response * Made tear down more resilent if staging is down * reverted e2e test to what was working before main merge * Updated backstopRef images * Updated gulp to include job-polling differently
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.example.gov/{{ 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.example.gov/rest-api.html" target="_blank" rel="noopener">REST API documentation</a> (this link opens in a new tab).</p>
|
||
|
||
{% endblock %}
|