{% extends "base.html" %}
{% block title %}{{ 'api_docs.title'|t(user.language) }} - {{ 'brand'|t(user.language) }}{% endblock %}
{% block content %}
{{ 'api_docs.permissions'|t(user.language) }}
{{ 'api_docs.permissions_desc'|t(user.language) }}
| {{ 'api_docs.scope'|t(user.language) }} | {{ 'api_docs.scope_desc'|t(user.language) }} | {{ 'api_docs.scope_endpoints'|t(user.language) }} |
profiles:read | {{ 'apikey.perm.profiles_read'|t(user.language) }} | GET /profiles, GET /profiles/{id} |
profiles:write | {{ 'apikey.perm.profiles_write'|t(user.language) }} | POST /profiles, PUT /profiles/{id}, DELETE /profiles/{id} |
postcards:read | {{ 'apikey.perm.postcards_read'|t(user.language) }} | GET /profiles/{id}/postcards, GET /profiles/{id}/postcards/{id} |
postcards:write | {{ 'apikey.perm.postcards_write'|t(user.language) }} | POST /profiles/{id}/postcards, PUT /profiles/{id}/postcards/{id}, DELETE /profiles/{id}/postcards/{id} |
images:upload | {{ 'apikey.perm.images_upload'|t(user.language) }} | POST /profiles/{id}/postcards/{id}/upload |
| {{ 'api_docs.permissions_keys_note'|t(user.language) }} |
{{ 'api_docs.permissions_note'|t(user.language) }}
{{ 'api_docs.profile_ops'|t(user.language) }}
{{ 'api_docs.ep.list_profiles'|t(user.language) }}
[
{"id": 1, "nickname": "Japan", "showcase_enabled": false, "showcase_visible": "both", "notes": "", "created_at": "2025-01-01T00:00:00"},
...
]
{{ 'api_docs.ep.create_profile'|t(user.language) }}
| {{ 'api_docs.body'|t(user.language) }} | |
| nickname | string {{ 'misc.required'|t(user.language) }} |
{"id": 2, "nickname": "Europe", ...}
{{ 'api_docs.ep.get_profile'|t(user.language) }}
{{ 'api_docs.ep.update_profile'|t(user.language) }}
| {{ 'api_docs.body'|t(user.language) }} | |
| nickname | {{ 'api_docs.ep.optional_str'|t(user.language) }} |
{{ 'api_docs.ep.delete_profile'|t(user.language) }}
{"ok": true}
{{ 'api_docs.postcard_ops'|t(user.language) }}
{{ 'api_docs.ep.list_postcards'|t(user.language) }}
| {{ 'api_docs.params'|t(user.language) }} | |
| status | string({{ 'api_docs.ep.optional_str'|t(user.language) }})— {{ 'api_docs.ep.filter_hint'|t(user.language) }} |
{{ 'api_docs.ep.create_postcard'|t(user.language) }}
| {{ 'api_docs.body'|t(user.language) }} | |
| card_number | string * {{ 'misc.required'|t(user.language) }} |
| status | string * {{ 'misc.required'|t(user.language) }} — sent / delivered / received |
| recipient_name | {{ 'api_docs.ep.optional_str'|t(user.language) }} |
| country | {{ 'api_docs.ep.optional_str'|t(user.language) }} — {{ 'api_docs.ep.country_hint'|t(user.language) }} |
| send_time | {{ 'api_docs.ep.optional_str'|t(user.language) }} — {{ 'api_docs.ep.date_hint'|t(user.language) }} |
| arrival_time | {{ 'api_docs.ep.optional_str'|t(user.language) }} |
| sender_name | {{ 'api_docs.ep.optional_str'|t(user.language) }} |
| receive_time | {{ 'api_docs.ep.optional_str'|t(user.language) }} |
| notes | {{ 'api_docs.ep.optional_str'|t(user.language) }} |
{{ 'api_docs.ep.get_postcard'|t(user.language) }}
{{ 'api_docs.ep.update_postcard'|t(user.language) }}
| {{ 'api_docs.body'|t(user.language) }} | |
| card_number | {{ 'api_docs.ep.optional_str'|t(user.language) }} |
| status | {{ 'api_docs.ep.optional_str'|t(user.language) }} |
| recipient_name | {{ 'api_docs.ep.optional_str'|t(user.language) }} |
| country | {{ 'api_docs.ep.optional_str'|t(user.language) }} |
| send_time | {{ 'api_docs.ep.optional_str'|t(user.language) }} |
| arrival_time | {{ 'api_docs.ep.optional_str'|t(user.language) }} |
| sender_name | {{ 'api_docs.ep.optional_str'|t(user.language) }} |
| receive_time | {{ 'api_docs.ep.optional_str'|t(user.language) }} |
| notes | {{ 'api_docs.ep.optional_str'|t(user.language) }} |
{{ 'api_docs.ep.delete_postcard'|t(user.language) }}
{"ok": true}