Merge pull request #3129 from alphagov/update-to-include-REST-API-doc-link

Add REST API link to /documentation page
This commit is contained in:
karlchillmaid
2019-09-26 12:50:34 +01:00
committed by GitHub
2 changed files with 5 additions and 9 deletions

View File

@@ -23,12 +23,8 @@
{% 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 class="heading-medium">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>
<h2 class="heading-medium">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 href="https://docs.notifications.service.gov.uk/api_doc_template.html" target="_blank" rel="noopener">REST API documentation</a> (this link opens in a new tab).</p>
{% endblock %}

View File

@@ -34,7 +34,7 @@ isort --check-only -rc ./app ./tests
display_result $? 2 "Import order check"
npm test
display_result $? 3 "Front end code style check"
display_result $? 3 "Javascript tests have failed"
## Code coverage
py.test -n auto --maxfail=10 --cov=app --cov-report=term-missing tests/ --junitxml=test_results.xml --strict -p no:warnings