请求通用定义
1. 通用约定
除各接口单独特定要求外,本平台对外提供的接口均遵循以下通用设计约定:
- 接口路径统一为:Base URL + 接口路径,接口文档中的路径已包含网关前缀
/open-api,直接拼接即可
- HTTP Method 为 POST,请求和响应参数均以 JSON 格式放在 Body 中
- 参数使用小驼峰式命名法(lower camel case)
- 请求字符集统一采用 UTF-8 编码,请求头需携带
Content-Type: application/json
2. 请求头
| Header |
必填 |
说明 |
| Content-Type |
是 |
application/json |
| X-AccessKey |
是 |
公开凭证,见鉴权与签名 |
| X-Timestamp |
是 |
请求时间戳(毫秒),见鉴权与签名 |
| X-Nonce |
是 |
8 位随机字母数字串,见鉴权与签名 |
| X-Signature |
是 |
HMAC-SHA256 签名值,见鉴权与签名 |
3. 字段类型定义
| 类型 |
说明 |
| String |
字符串 |
| Long |
长整型 |
| Array |
数组/列表 |
| Object |
对象 |
4. 单位约定
5. 幂等键
requestId 为全接口统一必传参数。写操作接口通过 requestId 实现幂等去重;查询类接口 requestId 用于请求链路追踪与日志关联,不参与幂等去重。生成规范与使用规则见幂等机制。