准备一枚 API 令牌,按下面三步调用。
登录管理后台创建 API 令牌,调用时放在请求头 X-API-Key。
向 /api/v1/query 提交好友码,成功会返回 task_id。
用 GET /api/v1/task/{id} 查询任务,直到完成。
国服、国际服查询,以及礼包、网页卡密。
好友码查询,适合 App、脚本和联调。
路径与鉴权和国服一致,单独走国际服接口。
查询礼包购买情况,或取消屏蔽并删除。
不方便带请求头时,使用卡密和 PoW。
查询、任务、健康检查都需要令牌。
| 方法 | 路径 | 用途 | 鉴权 |
|---|---|---|---|
| POST | /api/v1/query | 国服身高查询 | 令牌 |
| POST | /api/v1/intl/query | 国际服查询 | 令牌 |
| POST | /api/v1/gifts | 礼包购买情况 | 令牌 |
| POST | /api/v1/unblock | 取消屏蔽并删除 | 令牌 |
| GET | /api/v1/task/{id} | 查询异步任务 | 令牌 |
| GET | /api/v1/health | 健康检查 | 令牌 |
| GET | /web/v1/pow/challenge | 网页版 PoW | 无 |
| POST | /web/v1/query | 网页版国服查询 | 卡密 + PoW |
接入时这几条最常被问到。
首页是说明。请调用 POST /api/v1/query,不要请求根路径。
在请求头加上 X-API-Key。没有令牌可在管理后台创建。
查询是异步的。先拿到 task_id,再轮询 GET /api/v1/task/{id},建议超时不少于 60 秒。
API 给程序用,靠令牌。网页版走 /web/v1,需要卡密,并先请求 PoW。