5.7 KiB
5.7 KiB
API契约-成员视图
成员视图(令牌档)全部端点:令牌验证与页头、页面聚合、日志明细。《API契约-公共约定》(定稿)全部条款在此适用不再重述——前缀
/api/member、Bearer 鉴权、ISO 8601 UTC 左闭右开、quota_usd后端换算、snake_case 同构;管理面草案 §10 的裁定 1(聚合仅type = 2)与裁定 2(token_name取当前名)在此沿用。成员世界无审计、无健康带、无改密(定位边界,《交互设计-成员视图》§3)。
| 项目 | 内容 |
|---|---|
| 状态 | 定稿(2026-10-02) |
| 关联 | 《API契约-公共约定》(定稿——总纲)·《API契约-管理面》(草案——裁定沿用)·《交互设计-成员视图》·《交互设计-登录与会话》§4(登录壳)· members / usage_logs / payments 表字段设计(DTO 字段权威) |
| 产出 | 端点清单(3 个)、请求 / 响应字段、裁定项(§5)、遗留项(§6) |
1. 端点总览
| # | 端点 | 方法 | 用途 |
|---|---|---|---|
| 1 | /api/member/me |
GET | 令牌验证 + 页头(登录壳提交的落点) |
| 2 | /api/member/overview |
GET | 单页聚合:总用量、按来源分解、我的 key、支付参数卡 |
| 3 | /api/member/logs |
GET | 日志明细(名下 key,分页) |
2. 令牌验证与页头
GET /api/member/me → 200
{ "id": 1, "name": "小张" }
- 登录壳提交 = 前端将令牌存 sessionStorage 后调本端点(
Authorization: Bearer):验证通过(哈希命中 +status = active)→ 进入成员视图;401→ 登录壳(前端固定文案「令牌无效或已停用」,不区分停用与无效——公共约定 §2) - 不建会话:令牌即长期凭证(
members表设计 3.2——无会话语义、无登出端点);旧令牌在作者重发后于下一请求自然401
3. 单页聚合
GET /api/member/overview?from&to → 200
from/to 必填(快捷项为前端预置);聚合仅名下 key(经 api_key_id → api_keys.member_id 当前归属联查)的 type = 2 日志。
{
"member": { "id": 1, "name": "小张" },
"usage": { "count": 300, "quota": 1500000, "quota_usd": "3.00" },
"by_source": [
{ "billing_source": "subscription", "count": 280, "quota": 1400000, "quota_usd": "2.80" },
{ "billing_source": "wallet", "count": 20, "quota": 100000, "quota_usd": "0.20" }
],
"keys": [
{ "key_id": 5, "token_name": "小张-01", "log_synced_at": "2026-10-02T08:00:00Z",
"usage": { "count": 300, "quota": 1500000, "quota_usd": "3.00" } }
],
"payments": [
{ "id": 3, "kind": "subscription", "paid_at": "2026-09-01T00:00:00Z",
"paid_amount": 170, "remark": "九月拼车",
"period_start": "2026-09-01T00:00:00Z", "period_end": "2026-10-01T00:00:00Z",
"subscription_id": 3, "quota_granted": 12500000, "quota_usd": "25.00" }
]
}
usage:该时段总用量(聚合卡);by_source:订阅 / 充值分解(分段条);keys:我的 key 窄卡(log_synced_at支撑停滞标注)payments:支付参数卡 + 徽章展开行 + 「本订阅期间」快捷项的数据源,判定规则见 §5 裁定 2;对成员全字段可见(含remark——完全公开透明裁决);payments全空 = 纯用量模式中性空态(前端事)- 徽章展开行仅限「订阅 #N」徽章:「充值」不展开(余额池扣款挂不到具体某笔,展开无答案——§5 裁定 4)、「未关联」(日志缺
subscription_id)不可展开;降级:徽章subscription_id不在payments列表 → 「该订阅无登记信息」——空值场景各自归位(《交互设计-成员视图》§1.6)
4. 日志明细
GET /api/member/logs?from&to → 200 {items, total}
分页(公共约定 §6);过滤 from/to(必填);范围恒为名下 key、恒 type = 2(§5 裁定 1——成员世界是「我的用量」视角,错误行排查属管理面)。
明细行 DTO 与管理面 GET /api/admin/logs 同构(公共约定 §7——一份 DTO 类型两处复用):
{
"id": 12345, "api_key_id": 5, "created_at": "2026-10-01T14:22:05Z",
"token_name": "小张-01", "model_name": "gpt-5", "type": 2, "content": "",
"quota": 250000, "quota_usd": "0.50",
"prompt_tokens": 1200, "completion_tokens": 800,
"use_time": 3, "is_stream": true,
"billing_source": "subscription", "subscription_id": 3
}
token_name 取当前名(管理面裁定 2 沿用)。
5. 本稿裁定项(请作者重点审)
- 成员视图明细恒
type = 2——对齐聚合口径;无type筛选参数(管理面明细的全类型排查能力不进成员世界); - 「该时段涉及」支付记录的判定:订阅 = 该时段日志(
type = 2)出现过的subscription_id对应记录 ∪ 进行中的订阅(period_end为空或未来——支撑「本订阅期间」快捷项与「该订阅无登记信息」降级);充值 =paid_at ∈ [from, to)(充值消耗无逐笔关联可查,按支付时间锚定); - 明细行 DTO 与管理面同构:同一
LogItem类型,成员端经归属与type恒定过滤; - 「充值」徽章不展开——余额池扣款与具体充值记录无逐笔关联,展开回答不了「这笔花在哪」(《交互设计-成员视图》§1.6 未定义处的落定:徽章展开行仅限订阅徽章,「充值」为纯标识)。
6. 遗留项
- 订阅编号同一性核查(日志
subscription_id↔ 支付记录是否同一体系)——需求清单既有标注,实现期真实数据核查后再终验(徽章文案预留「未关联」正常位)。