DOCUMENTATION · 接入指南

$开发文档

四步完成接入:注册账号 → 创建应用 → 创建密钥 → 订阅接口并调用。接口详情页内置在线调试,可直接验证参数与响应。

快速开始

从注册到完成第一次调用

01 register

注册与登录

注册开发者账号并登录控制台。(当前站点已关闭自助注册)

02 app

创建应用

控制台「我的应用」创建应用,系统会自动生成默认应用,也可按需新建。

03 key

创建密钥

在应用下创建密钥得到 AK 与 SK;SK 明文仅展示一次,请立即保存。

04 invoke

订阅并调用

在「接口中心」订阅接口后,携带请求头访问 /gateway.php/{接口路径}。

两种调用方式

模式开关(应用维度)必带请求头适用场景
签名模式
默认、推荐
sign_required = 1 X-App-Key / X-Timestamp / X-Nonce / X-Sign 服务端、公网、生产环境,可防篡改与重放
免签名模式 sign_required = 0 X-App-Key 内网或无法计算 HMAC 的环境;AK 等同口令,务必配置 IP 白名单
~/examples/curl.sh

                
签名算法:X-Sign = HMAC_SHA256(大写METHOD \n PATH \n TIMESTAMP \n NONCE \n SHA1(BODY), SK),小写 hex
PATH 含前导斜杠且不含 gateway.php 与 query;时间戳为秒级,默认允许偏差 300 秒;nonce 不可重复。

免鉴权试用接口

接口中心标注「免费」的接口已开放游客调用:无需 AK 与签名,直接请求即可,按来源 IP 限流 (2 次/秒、200 次/日)。标注「限免」的接口在限免期内免订阅、不计费,但仍需携带密钥调用。
前往接口中心 →

常见网关错误码

错误码含义处理建议
4001密钥不存在或已禁用检查 AK 是否正确、密钥是否被禁用
4002签名校验失败核对 SK、待签串顺序与 BODY 原文
4003时间戳超期同步服务器时间,使用秒级时间戳
4004Nonce 重复每次请求生成新的随机 Nonce
4005IP 被拒绝在「黑白名单」中配置白名单
4008QPS 超限降低调用频率或提升配额
4009日配额用尽次日自动重置或提升配额
4010余额不足充值余额或购买资源包
4013未订阅该接口到「接口中心」订阅后重试