首页|接入文档
API v1

快速入门

API v1

快速入门

所有接入接口均位于 /api/v1/ 路径下,支持卡密验证账号验证两种模式。

公共参数

每次请求需要携带以下公共参数:

参数名类型必填说明
app_keystring软件的 App Key,在开发者控制台获取
noncestring随机字符串,每次请求唯一,用于防重放(建议 8-32 位随机字母数字)
timestampnumber当前 Unix 时间戳(秒),与服务器时间差不得超过 60 秒
signstringHMAC-SHA256 签名,详见签名算法

注意: 同一个 nonce 只能使用一次,服务器会拒绝重复的 nonce 请求。请确保每次请求生成新的随机字符串。

请求方式

  • GET 接口:参数放在 Query String 中
  • POST 接口:参数放在 JSON Body 中,Content-Type: application/json

推荐接入方式

JavaScript / TypeScript 项目建议直接使用官方 npm SDK:

npm install @ttqsoft/verify

SDK 会自动生成 noncetimestamp 并计算 HMAC-SHA256 签名,详见npm SDK。其他语言可按签名算法自行实现。

app_secret 用于生成签名,请只放在可信环境中,例如服务端、Electron 主进程或本地桌面程序。不要把 app_secret 暴露在普通浏览器前端代码里。