1.2 协议说明

1.2.1 业务说明

通讯方式采用HTTPS POST协议；

请求参数为JSON格式(application/json)。

字符编码UTF-8

1.2.2 接口地址说明

环境	地址
测试环境	https://prismalltest.95rg.cn/admin-api/openapi/gw
生产环境	https://prod.xxxxx/openapi

1.2.3 公共参请求参数

参数	类型	长度	必填	描述	示例值	说明
serviceCode	String	64	是	接口名称	HUARUN.A5757	每个接口对应唯一的一个serviceCode,本接口传固定的示例值
signMerchantNo	String	32	是	签名商户号	600003139169	饭卡通平台分配
requestNo	String	32	是	请求流水号	SEQ1615882557427	记录本次请求流水，推荐唯一值
requestTime	Long	14	是	unxi 时间戳（毫秒）		1615884035855 1970年至今毫秒数。时间戳5分钟有效期
charset	String	12	否	字符编码	UTF-8	默认：UTF-8
signType	String	32	是	签名方法	SHA256withRSA	默认：SHA256withRSA
encryptType	String	32	是	加密方法	AES	默认：AES
sign	String		是	签名	o/GcUXq+XPBdnQN3+s8U5n/dIM3d1CCA6xLaLR3y6qoJR7CFC2jNidL1s8rzi2Q9gaeFyy/RTsO2\r\n78AhPFawH0PKuTnJjEKxeNGglbFy55jsok/iOHsSbdFG/JINVedcQb4PEZ9LyCXIjsuA+6jLSnLh\r\nFwxw6frjmWigFtASHQM=	详见：签名说明
bizData	String		是	业务请求参数	d1Owy2aO8byaoUln4zh4uu9UTgfxx6oU3mbnko85eOW43A5+s	业务参数加密后数据（原业务参数格式为Object或Array）加密算法详见：加密说明具体业务参数见：业务请求参数（bizData）

请求报文示例

{
  "requestTime": 1615884035855,
  "charset": "UTF-8",
  "signMerchantNo": "600003139169",
  "serviceCode": "HUARUN.A5757",
  "sign": "o/GcUXq+XPBdnQN3+s8U5n/dIM3d1CCA6xLaLR3y6qoJR7CFC2jNidL1s8rzi2Q9gaeFyy/RTsO2\\r\\n78AhPFawH0PKuTnJjEKxeNGglbFy55jsok/iOHsSbdFG/JINVedcQb4PEZ9LyCXIjsuA+6jLSnLh\\r\\nFwxw6frjmWigFtASHQM=",
  "signType": "SHA256withRSA",
  "bizData": "d1Owy2aO8byaoUln4zh4uu9UTgfxx6oU3mbnko85eOW43A5+s",
  "requestNo": "SEQ1615882557427",
  "encryptType": "AES"
}

1.2.4 公共响应参数

参数	类型	长度	必填	描述	示例值	说明
code	String	12	是	通用网关响应码	0000	0000：代表请求成功具体参见：通用网关响应码说明
msg	String	64	是	通用网关响应码描述	成功	具体参见：通用网关响应码说明
signType	String	32	是	签名方法	SHA256withRSA	默认：SHA256withRSA
encryptType	String	14	是	加密方法）		默认：AES
sign	String		是	签名	o/GcUXq+XPBdnQN3+s8U5n/dIM3d1CCA6xLaLR3y6qoJR7CFC2jNidL1s8rzi2Q9gaeFyy/RTsO2\r\n78AhPFawH0PKuTnJjEKxeNGglbFy55jsok/iOHsSbdFG/JINVedcQb4PEZ9LyCXIjsuA+6jLSnLh\r\nFwxw6frjmWigFtASHQM=	详见：签名说明
bizData	String		是	业务请求参数	d1Owy2aO8byaoUln4zh4uu9UTgfxx6oU3mbnko85eOW43A5+s	业务参数加密后数据（原业务参数格式为Object或Array）加密算法详见：加密说明具体业务参数见：业务请求参数（bizData）

响应报文示例

{
  "msg": "成功",
  "code": "0000",
  "sign": "OrsHWAF57Qqmh2e/8vk8j+OYdcUAFDOf0lIRxQn04jR7AEBZPcCNP1AtQtniQf++WqSh/NZ91HK/\\nhrnJVKLBPSP2",
  "signType": "SHA256withRSA",
  "bizData": "aV5ldcdF3cH4Z9bPY481nd0I2VB3MD/qJAq4CNpbHA9jnc9qgRna489W4cVOJcYLa6RldDJyYAxa\\n/YvOX9hI0LRWZsnl8aih2BwnzDE/yVKM6tjWSWWqfxGHvkVQ",
  "encryptType": "AES"
}

1.2.5 加密和签名

📌

单击下载加密、签名 sign-demo.zip

签名规则：

bizData字段设置为未加密的原始业务参数json字符串；

去掉sign参数字段；

将报文json字符串按照key字典序升序排序（bizData中json字符串内容无需排序），具体字段以实际接口字段为准，参考示例如下:
{“bizData”:"{“这里是原文json字符串”}",
“charset”:“UTF-8”,
“encryptType”:“AES”,
“requestNo”:“062021102903491600000000006001”,
“requestTime”:1635493761519,
“serviceCode”:“C0001.A5031”,
“signMerchantNo”:“900000121808”,
“signType”:“SHA256withRSA”,
“version”:“1.0.0”}

将第3步生成的字符串,用商户侧RSA私钥进行SHA-256,生成签名。
sign = SHA256WithRSA("
{“bizData”:"{“这里是原文json字符串”}",
“charset”:“UTF-8”,
“encryptType”:“AES”,
“requestNo”:“062021102903491600000000006001”,
“requestTime”:1635493761519,
“serviceCode”:“C0001.A5031”,
“signMerchantNo”:“900000121808”,
“signType”:“SHA256withRSA”,
“version”:“1.0.0”}",
“商户侧RSA私钥”);

签名数据Base64编码；
验签规则：同签名逻辑，验签使用平安付提供的RSA公钥验证。

📌

注：
商户请求饭卡通平台的报文，商户加签使用商户侧私钥；
饭卡通平台响应给商户的报文，商户验签使用饭卡通平台侧的RSA公钥；
商户请求报文加密和对饭卡通平台响应报文解密均使用商户侧密钥。

1.2.6 签名和加密示例如下：

1.2.6.1 签名代码demo示例如下：

1.2.6.2 加密代码demo示例如下：

对bizData业务参数原json字符串进行AES128加密（加密数据Base64编码）
模式： AES/CBC/PKCS5Padding , 秘钥由饭卡通平台侧提供。
加密代码DEMO示例如下

1.2.1 业务说明#

1.2.2 接口地址说明#

1.2.3 公共参请求参数#

请求报文示例#

1.2.4 公共响应参数#

1.2.5 加密和签名#

1.2.6 签名和加密示例如下：#

1.2.6.1 签名代码demo示例如下：#

1.2.6.2 加密代码demo示例如下：#