1.4接口规范
- Open API 请求都使用 SHA256WithRSA 认证，以保证请求的完整性，真实性，同时做身份认证和鉴权；所以需要双⽅均设置ip⽩名单， 防⽌⾮法调⽤ 。
- 参数名 和 url 均⽤⼩写， 防⽌因为⼤⼩写问题增加额外的核对时间。
- 本接⼝规定所有的时间都以服务器的时间为准， 即东⼋区的北京时间为准， 客户端向服务端请求， 都以服务端的参考进⾏转换为服务的时间为准。
- 分页。查询记录列表都有分页，分页参数：
page表示页数，size表示每页大小。接口 DTO 统一返回total，records。 - 时间处理。API 请求和返回时间都是 UNIX 时间戳，秒为单位，避免因为时区导致误差
- 金额处理。API 请求和返回都是 String 字符串类型，避免精度丢失
- 所有带 body 的请求没有特殊说明body都是 JSON格式，
Content-Type：application/json - 所有查询接口查询时间间隔必须小于一个月
- 国际化。默认语言为英文，目前支持下面两种语言，通过在请求头中设置lang来修改语言
| 语言tag | 对应语言 |
|---|---|
| en | 英文 |
| zh-CN | 简体中文 |
- header头信息：
| 参数名称 | 参数类型 | 必填 | 描述 |
|---|---|---|---|
| timestamp | long | true | 时间戳，精确到秒 |
| nonce | string | true | 10位随机字符串 |
| api-key | string | true | 商户的唯一标识，由HyperCard颁发 |
| signature | string | true | 业务参数+请求头生成的签名 |
| version | string | true | 接口版本号,默认传1.0 |
| lang | string | false | 语言；不设置默认为英文，设置语言后在签名时也需要包含此字段。 |
- 接口返回格式统一：
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| code | 错误码。00000：正常，非00000：异常 | string |
| msg | 错误信息。成功为 ok，失败为错误描述 | string |
| data | 数据信息 | object |
- 响应状态：
| 状态码 | 说明 |
|---|---|
| 200 | OK |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |