四步完成接入:注册账号 → 创建应用 → 创建密钥 → 订阅接口并调用。接口详情页内置在线调试,可直接验证参数与响应。
从注册到完成第一次调用
注册开发者账号并登录控制台。(当前站点已关闭自助注册)
控制台「我的应用」创建应用,系统会自动生成默认应用,也可按需新建。
在应用下创建密钥得到 AK 与 SK;SK 明文仅展示一次,请立即保存。
在「接口中心」订阅接口后,携带请求头访问 /gateway.php/{接口路径}。
| 模式 | 开关(应用维度) | 必带请求头 | 适用场景 |
|---|---|---|---|
| 签名模式 默认、推荐 |
sign_required = 1 |
X-App-Key / X-Timestamp / X-Nonce / X-Sign |
服务端、公网、生产环境,可防篡改与重放 |
| 免签名模式 | sign_required = 0 |
X-App-Key |
内网或无法计算 HMAC 的环境;AK 等同口令,务必配置 IP 白名单 |
gateway.php 与 query;时间戳为秒级,默认允许偏差 300 秒;nonce 不可重复。
| 错误码 | 含义 | 处理建议 |
|---|---|---|
4001 | 密钥不存在或已禁用 | 检查 AK 是否正确、密钥是否被禁用 |
4002 | 签名校验失败 | 核对 SK、待签串顺序与 BODY 原文 |
4003 | 时间戳超期 | 同步服务器时间,使用秒级时间戳 |
4004 | Nonce 重复 | 每次请求生成新的随机 Nonce |
4005 | IP 被拒绝 | 在「黑白名单」中配置白名单 |
4008 | QPS 超限 | 降低调用频率或提升配额 |
4009 | 日配额用尽 | 次日自动重置或提升配额 |
4010 | 余额不足 | 充值余额或购买资源包 |
4013 | 未订阅该接口 | 到「接口中心」订阅后重试 |