接口总体说明
通信方式
Http(s)、字符编码:UTF-8 访问地址:http(s)://yourdomain:端口/
参数必传说明
Y:必填 N:非必填 C:条件必填,即参数的必填性取决于其他参数的值或某些条件,具体逻辑参照各参数的描述
固定请求参数
Header参数:
字段ID | 字段名称 | 类型 | 必传 | 备注 |
---|---|---|---|---|
sign | 签名值 | String | Y | 请求参数的签名值,校验请求数据的完整性对appAuthToken、uniqueCode以及业务请求参数进行排序签名,使用RSA算法生成签名值 |
Query或Body参数:
字段ID | 字段名称 | 类型 | 必传 | 备注 |
---|---|---|---|---|
appAuthToken | 授权凭证 | String | Y | 应用授权凭证 |
uniqueCode | 流水号 | String | Y | 流水号,用于标识某笔业务 |
固定响应参数
字段ID | 字段名称 | 类型 | 必传 | 备注 |
---|---|---|---|---|
code | 返回码 | integer | Y | 10000成功,其他参见附录 |
message | 返回描述 | String | Y | 返回描述,不可用于流程控制 |
result | 结果数据 | Object | Y | 返回的结果数据 |
timestamp | 时间戳 | Integer | Y | 时间戳 |
签名验签(验签暂未启用)
签名算法
使用RSA算法 (2048位),用客户的私钥对请求参数进行签名,生成sign(签名值),开放签使用其公钥对请求参数及签名值进行验签,验签通过后,进行业务处理。
计算sign(签名值)
POST:使用对接授权的私钥对请求body中的参数json进行签名,生成签名值sign;
GET:对appAuthToken、uniqueCode以及业务请求参数中的每个参数进行拼接并排序,生成待签名数据,使用对接授权的私钥对待签名数据进行签名,生成签名值sign。