调用地址
{协议}://{API域名}/{调用路径}
| 调用路径 | 后台 → 创建接口后自动生成 | 注意所有接口 必须 POST 请求。 |
两种卡密
| 充值卡密 | card | 给用户账号充值续费 | 两者不可混用,各有独立接口。 |
对接流程
第一步:配置后台开始写代码前,先在后台完成 传输配置(加密、签名、返回值格式)。也可以在后台「SDK 下载与注入」页面一键自动配置并下载已注入配置信息的 SDK。
单码卡密模式
适合无账号体系的场景(卡密即账号):
1. 调用 [单码登录](/api/kami-login) → 传入 kami + imei → 获得 statecode
2. 定时调用 [心跳验证](/api/kami-heartbeat) → 传入 statecode → 维持在线
用户模式
适合需要注册/登录/改密的场景:
1. 调用 [用户注册](/api/user-register) → 传入 user + pass
2. 使用 [充值卡密](/api/recharge) 给账号充值
3. 调用 [用户登录](/api/user-login) → 传入 user + pass + imei → 获得 statecode
4. 定时调用 [心跳验证](/api/user-heartbeat) → 传入 statecode → 维持在线
通用参数
以下参数 所有接口 都可以传,是否必填看后台配置:
t | number | 10 位秒级时间戳,与服务器时差 ≤ 30s。开启时间戳校验时必填 |
s | string | MD5 签名(32 位小写)。开启签名校验时必填。算法见 签名校验 |
safe_code | string | 防篡改验证码,服务器原样返回 |
通用响应
json
{
"code": 200,
"msg": "操作成功",
"time": 1741700000
}
code — 200 成功,201 失败。类型(int/string)由后台「返回值配置」决定msg — 成功时为数据,失败时为错误描述time — 开启「JSON 返回时间戳」后携带
下一步
后台快速配置 →加密、签名、返回值格式接口一览 →全部 22 个 API错误消息参考 →错误码 + 排障指南