{% extends "base.html" %}
{% block title %}{{ 'api_docs.title'|t(user.language) }} - {{ 'brand'|t(user.language) }}{% endblock %}
{% block content %}
{{ 'api_docs.base_url'|t(user.language) }}
{{ request.base_url }}api/v1
{{ 'api_docs.auth'|t(user.language) }}
{{ 'api_docs.auth_desc'|t(user.language) }}
X-API-Key: mv_your_api_key_here
{{ 'api_docs.profile_ops'|t(user.language) }}
获取当前用户的所有 Profile 列表。
[
{"id": 1, "nickname": "Japan", "showcase_enabled": false, "showcase_visible": "both", "notes": "", "created_at": "2025-01-01T00:00:00"},
...
]
创建新 Profile。
| {{ 'api_docs.body'|t(user.language) }} | |
| nickname | string {{ 'misc.required'|t(user.language) }} |
{"id": 2, "nickname": "Europe", ...}
更新 Profile。
| {{ 'api_docs.body'|t(user.language) }} | |
| nickname | string(可选) |
删除 Profile 及其下所有明信片。
{"ok": true}
{{ 'api_docs.postcard_ops'|t(user.language) }}
获取指定 Profile 下的明信片列表。
| {{ 'api_docs.params'|t(user.language) }} | |
| status | string(可选)— 按状态筛选:sent / delivered / received |
创建新明信片。
| {{ '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 | string(可选) |
| country | string(可选)— 两个大写字母,如 JP |
| send_time | string(可选)— 格式 YYYY-MM-DD 或 YYYY-MM-DDTHH:MM |
| arrival_time | string(可选) |
| sender_name | string(可选) |
| receive_time | string(可选) |
| notes | string(可选) |
更新明信片。仅传入需要修改的字段。
| {{ 'api_docs.body'|t(user.language) }} | |
| card_number | string(可选) |
| status | string(可选) |
| recipient_name | string(可选) |
| country | string(可选) |
| send_time | string(可选) |
| arrival_time | string(可选) |
| sender_name | string(可选) |
| receive_time | string(可选) |
| notes | string(可选) |
{{ 'api_docs.upload_op'|t(user.language) }}
上传明信片图片(正面或背面),使用 multipart/form-data。
| Form Field | |
| file | File * {{ 'misc.required'|t(user.language) }} — 图片文件 |
| side | string(可选)— front 或 back,默认 front |
{{ 'api_docs.key_ops'|t(user.language) }}
创建新的 API Key。创建后完整 Key 仅在响应中显示一次。
| {{ 'api_docs.body'|t(user.language) }} | |
| name | string(可选)— Key 的备注名称 |
删除指定 API Key。
{"ok": true}
{{ 'api_docs.showcase_ops'|t(user.language) }}
{{ 'api_docs.no_auth'|t(user.language) }} — 获取用户的公开展示数据。
{{ 'api_docs.no_auth'|t(user.language) }} — 获取单个 Profile 的展示数据。
{% endblock %}