Skip to content

接口规范定义

以下是您需要为我们提供的接口,我们将调用这些接口来管理用户余额和消费。

接口通用要求

  • 协议:HTTPS

  • 数据格式:JSON

  • 字符编码:UTF-8

  • 超时时间:建议5秒

所有接口通用响应格式

json
{
  "code": 10200,
  "success": true,
  "message": "OK",
  "data": {},
  "timestamp": 1760582574528
}
字段名类型说明
codenumber业务状态码。
successboolean是否成功。方便前端直接判断逻辑。
messagestring响应提示信息(例如 "OK"
dataobject实际业务数据。
timestampnumber服务器响应时间戳(毫秒)。

状态码对照表

状态码含义说明
10200成功请求处理成功
10400参数错误请求参数格式不正确
10401签名验证失败签名校验不通过
10402余额不足用户余额不足
10429请求过于频繁请稍后重试
10500系统内部异常服务器错误
10900重复请求相同的请求ID已处理

通用请求头

Header 名称是否必填示例值说明
AuthorizationBearer apiKeyAPI 认证凭据
X-Signaturesha256Hex(sort(params)+apiSecret)请求签名

签名算法

签名用于验证请求合法性。

计算公式:

计算公式

text
signature = sha256Hex(sort(params) + apiSecret)

计算步骤:

  1. 对请求体参数(不包括空值)按参数名升序排序;

  2. 拼接为字符串:

text
key1=value1&key2=value2&...
  1. 在末尾拼接你的 apiSecret

  2. 对整个字符串计算 SHA256 Hex 哈希。

参数示例:

json
{
  "account": "680857435",
  "name": "sona",
  "avatar": "https://xxx.png",
  "gender": "male",
  "age": 18
}

计算字符串:

text
account=680857435&age=18&avatar=https://xxx.png&gender=male&name=sona

结果:

text
X-Signature: 8e2a0d7a9c0a55d92f123ab1d8913a2d12cd1b6b6a7c17b3bb6ef9a9b1a0e421

Released under the MIT License.