- 站点级凭证:商城后台 → 商品对接 → 开放接口,启用后获取 AppID 与 Secret。
- 用户级凭证:商城前台 → 个人中心 → API 对接,生成 32 位 AppID / AppKey, 支持 IP 白名单,余额查询返回该用户余额。密钥仅在生成时展示一次。
接入说明
正式对接前请先获取凭证并了解签名规则,所有接口共用同一套请求格式。
1. 获取凭证
可在两处获取对接凭证:
2. 请求格式
所有接口均为 POST,请求体为 JSON:
请求示例
{{ signatureExample }}
- appid:对接凭证中的 AppID。
- timestamp:秒级时间戳,与服务器时间相差不能超过 300 秒。
- sign:md5(appid + timestamp + secret),32 位小写。
- data:业务参数,没有参数时传 {}。
3. 签名示例
{{ currentCode }}
4. 返回格式
所有接口 HTTP 状态码均为 200,业务结果以 code 判断:
| code | 说明 |
|---|---|
| 200 | 成功,业务数据在 data 中。 |
| 400 | 失败,错误原因在 msg 中,例如签名错误、库存不足等。 |
常见错误:AppID 不正确、签名错误、时间戳已过期、IP 不在白名单内、商品不存在或已下架、商品库存不足、缺少订单号、订单不存在。
{{ endpoint.title }}
{{ endpoint.summary }}
POST
{{ endpoint.path }}
{{ endpoint.title }}
{{ endpoint.desc }}
请求参数(data)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| {{ param.name }} | {{ param.type }} | {{ param.required ? '必填' : '可选' }} | {{ param.desc }} |
| 无参数,传 {} 即可。 | |||
请求示例
JSON
{{ endpoint.request }}
返回示例
JSON
{{ endpoint.response }}
返回字段
| 字段 | 类型 | 说明 |
|---|---|---|
| {{ field.name }} | {{ field.type }} | {{ field.desc }} |
{{ endpoint.note }}
常见问题
签名一直提示错误?
请确认拼接顺序是 appid + timestamp + secret,
中间不要加分隔符;timestamp 必须是秒级数字;MD5 结果为 32 位小写。
提示 IP 不在白名单?
用户级凭证可在个人中心「API 对接」中配置白名单,支持单个 IP、CIDR 网段或 *。
站点级凭证默认不校验 IP。
下单后没有立即返回卡密?
部分对接商品需要上游异步采购,此时返回 state = 2,
请使用订单号调用「订单查询」接口轮询,直到 state = 1 并拿到 return 内容。