Appearance
接口通用规范与签名机制
请求头规范
推荐统一携带以下头部:
Authorization: Bearer {access_token}Content-Type: application/jsonX-Client-VersionX-Device-IdX-TimestampX-Signature
响应结构
统一响应格式:
code:业务状态码message:响应消息data:业务数据meta:附加元信息,如timestamp、request_id
错误码
200:成功400:参数错误401:未授权403:权限不足404:资源不存在429:请求频率超限500:服务器内部错误503:服务暂时不可用
签名规则
- 将请求参数按字典序排序
- 拼接为签名字符串:
timestamp + sortedParams + secret - 使用
HMAC-SHA256计算签名 - 将签名值放入
X-Signature
实施建议
- 客户端与服务端统一签名字段顺序
- 对时间戳做有效期校验,防重放攻击
- 保留 request_id 用于链路追踪
