开放 API · Open Platform

对接文档

统一入口 api.php?act=… 分发业务；进度推荐独立接口 /api/search.php。 推荐 Header HMAC-SHA256（Sign + Timestamp + Uid，±90s 防重放）； 多数接口兼容简单 Key / Authorization。/api/search.php 同样支持 HMAC / 简单 Key / Authorization 三种鉴权。 Body 只放业务参数，禁止 GET 明文传 key。IP 白名单 fail-closed。

POST JSON / Form HMAC-SHA256 IP 白名单 防重放 ±90s
接口地址
复制
请先在「个人中心」配置对接密钥与 IP 白名单。未配置白名单将拒绝全部请求。 查课余额 < 50 会失败（白名单 uid 除外）；下单按费率价扣费。 下单成功 code=0 且返回 id；其它接口成功多为 code=1。

推荐对接流程

按顺序调用，点击卡片跳转到对应接口
{{ i + 1 }}

{{ f.title }}

{{ f.desc }}

{{ f.act }}

常见返回码

业务 code，与 HTTP 状态码无关
{{ e.code }} {{ e.msg }}

认证与签名

三种方式任选其一（推荐方式 1）

推荐 方式 1 · HMAC 签名

Header 传 Uid Timestamp Sign。Sign = HMAC-SHA256(Timestamp + JSON Body, key)。Body 先 ksort 再 json_encode；空体用 {}。±90s 防重放。/api/search.php 也支持 Authorization（Bearer uid:apikey）。

兼容 方式 2 · 简单 Key

Header 或 POST 传 uid + key（对接密钥）。仅 api.php 的 apiAuth 接口支持。禁止 GET 明文传 key。

可选 方式 3 · Authorization

Header：Authorization: uid:apikey 或 Bearer uid:apikey。同样仅 api.php 支持。

STEP 01
准备业务参数
仅放业务字段，不传 uid / key
STEP 02
ksort + JSON
ksort 后 json_encode，空体用 {}
STEP 03
13 位毫秒时间戳
与服务端误差须在 ±90 秒内
STEP 04
计算 Sign
hash_hmac('sha256', ts + body, key)
Sign = hash_hmac('sha256', Timestamp + json_encode(ksort($data)), $apiKey)

接口列表

点击左侧接口查看详情与对接示例
请选择左侧接口

尊敬的用户：

  • 所有 API 均需鉴权。推荐 HMAC-SHA256(Timestamp + JSON Body, key)。
  • Body 只传业务参数，不要放 uid / key；发送前对参数 ksort 再 json_encode。
  • 请先配置 IP 白名单与对接密钥，否则请求会被拒绝。
  • 时间戳为 13 位毫秒，误差超过 ±90 秒会失败；签名请求有防重放保护。

如有疑问请通过工单联系客服。