API 文档
公共参数
请求头
| 名称 | 必填 | 描述 | 备注 | 示例值 |
|---|---|---|---|---|
customerId | Y | 客户 ID | 预先配置。 | ASR3F1B4Z5 |
service | Y | API 名称 | 详见API 列表。 | createCard |
version | Y | API 版本 | 当前版本2.0。 | 2.0 |
requestId | Y | 请求流水号 | 每个请求唯一,建议使用UUID。 | 472f37e3-a803-47ed-b9b6-32632895b466 |
timestamp | Y | 请求时间 | UNIX 时间戳(毫秒)。 | 1642747436113 |
sign | Y | 请求数据签名 | 详见签名机制。 | +Ue0BiWsCOxbYD39Ldd(部分数据) |
响应头
| 名称 | 描述 | 备注 | 示例值 |
|---|---|---|---|
customerId | 客户 ID | 请求头原样返回。 | ASR3F1B4Z5 |
service | API 名称 | 请求头原样返回。 | createCard |
version | API 版本 | 请求头原样返回。 | 2.0 |
requestId | 请求流水号 | 请求头原样返回。 | 472f37e3-a803-47ed-b9b6-32632895b466 |
timestamp | 响应时间 | UNIX 时间戳(毫秒)。 | 1642747437393 |
code | 响应码 | 枚举值,3位数字,详见响应码下拉框。 | 200(非200表示 API 调用失败) |
message | 响应码详情 | 详见响应码下拉框。 | succeed |
sign | 响应数据签名 | 详见签名机制。 | WO8waUZ30bYlKp/+s9m(部分数据) |
📋响应码
| code | message | 备注 |
|---|---|---|
200 | succeed | 成功。 |
400 | payload decrypt failed | 无法解密数据。 |
403 | the ip is not whitelisted | 请求 IP 不在白名单。 |
405 | unsupported method | 请求方法不支持。(仅支持POST) |
406 | too many requests | 请求过于频繁。 |
407 | verify sign failed | 无法验证签名。 |
417 | the parameter is null or invalid | 请求头必填参数为空。 |
500 | (不固定) | 系统错误。 |
API 列表
| 名称 | 方法 | 请求头 service 参数 |
|---|---|---|
| 创建卡 | POST | createCard |
| 修改卡 | POST | updateCard |
| 充值卡 | POST | rechargeCard |