mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-02-28 06:11:03 -05:00
44a0845882
In research we found that developers orientate themselves around the API clients rather than the documentation. We should get them to the client documentation as quickly as possible. We currently link to the API documentation in three places: - API integration page - global footer - template ‘API info’ page For the first two this commit: - removes the link to the documentation - adds links to each of the 5 clients For the last one it just removes the link entirely.
77 lines
2.3 KiB
HTML
77 lines
2.3 KiB
HTML
{% extends "withnav_template.html" %}
|
||
{% from "components/table.html" import list_table, field, hidden_field_heading %}
|
||
{% from "components/api-key.html" import api_key %}
|
||
|
||
{% block page_title %}
|
||
API integration – GOV.UK Notify
|
||
{% endblock %}
|
||
|
||
{% block maincolumn_content %}
|
||
|
||
<div class="grid-row">
|
||
<div class="column-two-thirds">
|
||
<h1 class="heading-large">
|
||
API integration
|
||
</h1>
|
||
</div>
|
||
<div class="column-one-third">
|
||
<a href="{{ url_for('.create_api_key', service_id=current_service.id) }}" class="button align-with-heading">Create an API key</a>
|
||
</div>
|
||
</div>
|
||
|
||
{% call(item, row_number) list_table(
|
||
keys,
|
||
empty_message="You haven’t created any API keys yet",
|
||
caption="API keys",
|
||
caption_visible=false,
|
||
field_headings=[
|
||
'API keys',
|
||
hidden_field_heading('Action')
|
||
],
|
||
) %}
|
||
{% call field() %}
|
||
<div class="file-list">
|
||
{{ item.name }}
|
||
<span class="file-list-hint">
|
||
{% if item.key_type == 'normal' %}
|
||
<span class="visually-hidden">Normal</span>
|
||
{% elif item.key_type == 'team' %}
|
||
Only sends to team members
|
||
{% elif item.key_type == 'test' %}
|
||
Simulates sending messages
|
||
{% endif %}
|
||
</span>
|
||
</div>
|
||
{% endcall %}
|
||
{% if item.expiry_date %}
|
||
{% call field(align='right') %}
|
||
Revoked {{ item.expiry_date|format_datetime_short }}
|
||
{% endcall %}
|
||
{% else %}
|
||
{% call field(align='right', status='error') %}
|
||
<a href='{{ url_for('.revoke_api_key', service_id=current_service.id, key_id=item.id) }}'>Revoke</a>
|
||
{% endcall %}
|
||
{% endif %}
|
||
{% endcall %}
|
||
|
||
<div class="bottom-gutter">
|
||
{{ api_key(current_service.id, "Service ID", thing="service ID") }}
|
||
</div>
|
||
|
||
<h2 class="heading-small">API clients</h2>
|
||
<ul class="list list-bullet">
|
||
{% for name, url in [
|
||
('Java', 'https://github.com/alphagov/notifications-java-client'),
|
||
('Node JS', 'https://github.com/alphagov/notifications-node-client'),
|
||
('PHP', 'https://github.com/alphagov/notifications-php-client'),
|
||
('Python', 'https://github.com/alphagov/notifications-python-client'),
|
||
('Ruby', 'https://github.com/alphagov/notifications-ruby-client')
|
||
] %}
|
||
<li>
|
||
<a href="{{ url }}">{{ name }}</a>
|
||
</li>
|
||
{% endfor %}
|
||
</ul>
|
||
|
||
{% endblock %}
|