a563c1ca4b
docs/api目录文档分类和补全 --------- Co-authored-by: guke <guke@autohome.com.cn> Reviewed-on: #111
2.3 KiB
2.3 KiB
GET /api/v1/compare/milestones — 比价战绩里程碑进度
所属:比价记录组(前缀
/api/v1/compare) | 鉴权:Bearer | ← 返回 API 索引
福利页「记录比价战绩」的数据源。返回各档(第 1~6 次)解锁/领取状态。
解锁进度 = 当前用户 comparison_record 里 status='success' 的条数(只算成功比价,失败的不计入)。第 N 档在「成功比价次数 ≥ N」时解锁;每档领一次(领取见 claim 接口)。
档位金额是产品规则,定义在后端 app/core/rewards.py 的 RECORD_MILESTONES(当前 120/180/300/500/800/1200),客户端不要写死,以本接口返回为准。
⚠️ 当前领取暂不真发金币(产品定,后续整体删除该功能):
coin仍返回产品规则值仅供展示,但 claim 接口 实际coin_awarded恒为 0、余额不变。前端展示须与之对齐,勿让用户误以为领取可到账。
入参
无(用户身份取自 Bearer token)。
出参
响应 200:
| 字段 | 类型 | 说明 |
|---|---|---|
success_count |
int | 累计成功比价次数(解锁进度) |
claimable_count |
int | 当前可领(state=active)的档数 |
milestones |
Milestone[] | 各档状态,按 milestone 升序 |
Milestone
| 字段 | 类型 | 说明 |
|---|---|---|
milestone |
int | 档位序号(1-based),= 解锁所需的成功比价次数 |
coin |
int | 该档应发金币额(产品规则值);⚠️ 当前领取不真发,见上方说明 |
state |
string | claimed(已领) / active(已解锁可领) / locked(未解锁) |
{
"success_count": 2,
"claimable_count": 1,
"milestones": [
{"milestone": 1, "coin": 120, "state": "claimed"},
{"milestone": 2, "coin": 180, "state": "active"},
{"milestone": 3, "coin": 300, "state": "locked"},
{"milestone": 4, "coin": 500, "state": "locked"},
{"milestone": 5, "coin": 800, "state": "locked"},
{"milestone": 6, "coin": 1200, "state": "locked"}
]
}
错误
401未鉴权
说明
- 同时可有多档处于
active(如累计 3 次却一档没领,则前 3 档都可领),逐档调 claim。 - 进度只增不减:领取不消耗成功次数,只是把对应档从 active→claimed。