{% extends "base.html" %} {% block title %}{{ 'api_docs.title'|t(user.language) }} - {{ 'brand'|t(user.language) }}{% endblock %} {% block content %}

{{ 'api_docs.title'|t(user.language) }}

{{ 'api_docs.intro'|t(user.language) }}

{{ 'api_docs.go_settings'|t(user.language) }}

{{ '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) }}

GET /profiles
获取当前用户的所有 Profile 列表。
[ {"id": 1, "nickname": "Japan", "showcase_enabled": false, "showcase_visible": "both", "notes": "", "created_at": "2025-01-01T00:00:00"}, ... ]
POST /profiles
创建新 Profile。
{{ 'api_docs.body'|t(user.language) }}
nicknamestring {{ 'misc.required'|t(user.language) }}
{"id": 2, "nickname": "Europe", ...}
GET /profiles/{id}
获取单个 Profile 详情。
PUT /profiles/{id}
更新 Profile。
{{ 'api_docs.body'|t(user.language) }}
nicknamestring(可选)
DELETE /profiles/{id}
删除 Profile 及其下所有明信片。
{"ok": true}

{{ 'api_docs.postcard_ops'|t(user.language) }}

GET /profiles/{profile_id}/postcards
获取指定 Profile 下的明信片列表。
{{ 'api_docs.params'|t(user.language) }}
statusstring(可选)— 按状态筛选:sent / delivered / received
POST /profiles/{profile_id}/postcards
创建新明信片。
{{ 'api_docs.body'|t(user.language) }}
card_numberstring * {{ 'misc.required'|t(user.language) }}
statusstring * {{ 'misc.required'|t(user.language) }} — sent / delivered / received
recipient_namestring(可选)
countrystring(可选)— 两个大写字母,如 JP
send_timestring(可选)— 格式 YYYY-MM-DD 或 YYYY-MM-DDTHH:MM
arrival_timestring(可选)
sender_namestring(可选)
receive_timestring(可选)
notesstring(可选)
GET /profiles/{profile_id}/postcards/{id}
获取单张明信片详情。
PUT /profiles/{profile_id}/postcards/{id}
更新明信片。仅传入需要修改的字段。
{{ 'api_docs.body'|t(user.language) }}
card_numberstring(可选)
statusstring(可选)
recipient_namestring(可选)
countrystring(可选)
send_timestring(可选)
arrival_timestring(可选)
sender_namestring(可选)
receive_timestring(可选)
notesstring(可选)
DELETE /profiles/{profile_id}/postcards/{id}
删除单张明信片。
{"ok": true}

{{ 'api_docs.upload_op'|t(user.language) }}

POST /profiles/{profile_id}/postcards/{id}/upload
上传明信片图片(正面或背面),使用 multipart/form-data
Form Field
fileFile * {{ 'misc.required'|t(user.language) }} — 图片文件
sidestring(可选)— front 或 back,默认 front

{{ 'api_docs.key_ops'|t(user.language) }}

GET /keys
获取当前用户的所有 API Key。
POST /keys
创建新的 API Key。创建后完整 Key 仅在响应中显示一次。
{{ 'api_docs.body'|t(user.language) }}
namestring(可选)— Key 的备注名称
DELETE /keys/{id}
删除指定 API Key。
{"ok": true}

{{ 'api_docs.showcase_ops'|t(user.language) }}

GET /showcase/{username}
{{ 'api_docs.no_auth'|t(user.language) }} — 获取用户的公开展示数据。
GET /showcase/{username}/profile/{id}
{{ 'api_docs.no_auth'|t(user.language) }} — 获取单个 Profile 的展示数据。

{{ 'api_docs.try_it'|t(user.language) }}

{% endblock %}