简要描述

• 全局请求头说明

请求规范

基础信息

• 接口协议：HTTPS
• 数据格式：JSON
• 请求方式：GET、POST 等

通用请求头

参数名	必选	类型	说明
Authorization	✅	string	用户认证 Token，格式为 Bearer <token>
Accept	✅	string	接受数据格式
Content-Type	❌	string	请求数据格式, post请求为 application/json

通用接口响应格式

无数据列表的响应参数说明

参数名	类型	说明
code	number	响应状态码, 详见 后端响应状态码说明
message	string	响应的消息提示
data	Object	响应的数据

无数据列表的响应示例

  {
	  "code": 200,
	  "message": "操作成功",
	  "data": {}
  }

有数据列表的响应,data参数说明

• code, message, data 与上述一致

参数名	类型	说明
page	number	当前页页码
size	number	每页数据量
total	number	总数据条数
list	Array	响应的数据

有数据列表的响应示例

{
  "code": 200,
  "message": "操作成功",
  "data": {
    page: 1,
    size: 15,
    total: 66,
    list: []
  }
}

签名机制

签名秘钥生成方式

• 将接口中的请求字段按照Ascii码方式进行升序排序
• 按照 key1=val1&key2=val2&key3=val3…&key=md5秘钥
• 将上一步生成的字符串进行MD5加密

签名示例

请求参数

{
  "amount": "100",
  "order_no": "ts3023423423",
  "key": "adesf235"
}

TypeScript 请求示例

import * as crypto from 'crypto'

const payload = {
  amount: "100",
  order_no: "ts3023423423",
}

const secret = "adesf235" // md5秘钥

// 1. 排序（ASCII码升序）
const sortedKeys = Object.keys(payload).sort()

// 2. 拼接为 key1=val1&key2=val2... 的格式（不包含 key 字段）
const signingString = sortedKeys
  .filter(key => key !== 'key') // 去掉 key 字段
  .map(key => `${key}=${payload[key]}`)
  .join('&') + `&key=${secret}`

// 3. 进行 MD5 加密
const signature = crypto.createHash('md5').update(signingString).digest('hex')

console.log("签名前字符串:", signingString)
console.log("签名:", signature)

---

备注

• 更多关于全局请求接口的问题请咨询管理员
• 更新日期: 2024-04-24