# 1. 接口说明
# 1.1 接口URL
调用渠道方的服务 URL 地址,需提供以下 2 个环境:
调用环境 | 服务URL |
---|---|
测试环境(双方人员联调使用) | 线下沟通 |
正式环境 | 线下沟通 |
# 1.2 数据交互规范
使用 HTTPS 协议进行安全数据通信
使用 POST 方式发送请求;支持 application/json
参数值和返回的数据均使用 UTF-8 编码,返回数据使用 JSON 格式
所有请求响应参数均进行加密签名,加密签名参考加解密加验签demo
接口保持幂等性:重复请求请返回相同的结果
# 1.3 公共请求参数
参数名称 | 类型 | 是否必传 | 说明 | 备注 |
---|---|---|---|---|
channel | string | 是 | 渠道方名称 | 公共参数。 |
t | long | 是 | 系统时间 | 公共参数。单位:毫秒(System.currentTimeMillis()),长度:13 |
key | string | 是 | AES秘钥 | RSA公钥加密后的AES秘钥,每次请求随机生成,具体参考加解密加验签demo |
sign | string | 是 | RAS签名 | RAS签名,对公共请求参数中除sign字段的所有参数签名的结果。具体参考加解密加验签demo |
params | string | 是 | 密文业务数据 | 密文业务数据,为AES加密后的业务参数。具体参考加解密加验签demo |
# 1.4 公共响应参数
参数名称 | 值类型 | 是否必传 | 说明 | 备注 |
---|---|---|---|---|
code | String | 是 | 操作返回码 | 参考1.5 公共错误码 |
msg | string | 是 | 操作信息 | 参考1.5 公共错误码 |
data | string | 否 | 密文业务数据 | AES加密后的业务数据,具体参考加解密加验签demo |
key | string | 否 | AES秘钥密文 | RSA公钥加密后的AES秘钥,每次响应随机生成,具体参考加解密加验签demo |
sign | string | 是 | RSA签名 | RSA签名,对公共响应参数中除sign字段的所有参数签名的结果。具体参考加解密加验签demo |
# 1.5 公共错误码
code | Msg | 含义说明 |
---|---|---|
0000 | 操作成功 | 操作成功 |
0002 | 签名为空或错误 | 签名为空或错误 |
9999 | 业务异常 | 业务异常 |
# 1.6 加解密验签工具
见附录
RSA公私钥说明:双方各生成一对RSA公私钥,将公钥提供给对方,私钥己方妥善保存。使用对方公钥加密验签,己方私钥解密加签