1. 协议规则

接入方对接API须遵循以下规则：

传输方式：HTTPS

提交方式：采用POST方式提交

数据格式：JSON

字符编码：统一采用UTF-8字符编码

签名算法：RSA2

所有图片地址都必须是https协议开头

注意事项

2. 公共参数

2.1 通用报文格式

【公共请求参数】

参数名称	参数含义	是否必须	数据类型	备注
appId	应用APPID	Y	string	商户应用APPID
version	版本号	N	string	默认1.0。该参数将不在文档内显示，将根据部分定制化需求进行调整最新版本为1.01
timestamp	时间戳	Y	string	请求时间戳单位秒，要求timestamp与当前时间间隔在60秒以内
requestId	请求id	Y	string	请求唯一标识，无其他意义，必须每一次请求不允许重复，用于定位问题
subSn	子商户编码	N	string	非必传项，普通商户可忽略，平台商户以及代理商可传
signType	签名方式	Y	string	固定值：RSA2
bizContent	请求参数	Y	jsonObject	请求参数,JSON 格式字符串
sign	签名	Y	string	参照签名方法

版本号说明：我司对集团企业，政府部门，事业单位，大型综合体等企业的定制化需求对指定接口进行定制化调整，将根据版本号做不同适配，其中包含对字段增减，以及相关效验规则判断，无定制化需求的企业无需传入版本号，系统将自动使用默认1.0版本

【公共返回参数】

参数名称	参数含义	是否必须	数据类型	备注
code	请求状态	Y	integer	返回200=成功，其他状态均为失败
msg	状态说明	Y	string	如请求失败可查看该值判断错误原因
timestamp	时间戳	C	string	返回时间戳，失败时不会返回
sign	签名值	C	string	签名值，失败时不会返回
sn	商户编号	C	string	商户编号，失败时不会返回
signType	签名方式	C	string	固定值RSA2 ，失败时不会返回
data	返回数据体	C	Object	返回数据体，失败时不会返回

2.2 报文示例

【请求报文】

{
    "appId": "APP_1961555003",
    "timestamp": "1733122064",
    "sign": "AIdFcOQ9fbbU8VBr8GSmfoWQ6VfvSWLDi0RyUYSNVOXdVgN7lXVx4Y+0adD2fywctCz8qxEf5p7Sy34Zwi3nmKznhPpwAMlEPZyhgEBwRcozqF9qBQcKxi/o+yLNG1a4HDS6uJEXwgFl8yzju8+GjNIvBXi+wSJmmgs9hoK0V+V377KZuv/rUrSjefYru7I1IcV89vee3UfJxEZPL94DsLb6L0mROkQWe7ujI4NgZRtyUX68jlVpf2hu7HMWoQvyu/ypToJ7FbcVnKkJNOj9YJHVi9D9ZvcutZu7fLGPu8AslM4JQMFkcW/iZDUVJhmFuJJuxFcmpGoDT2f8O+8img==",
    "bizContent": "",
    "requestId": "1733122064413",
    "signType": "RSA2"
}

【应答报文】

{
    "code": 200,
    "appId": "APP_1961555003",
    "timestamp": 1733122064,
    "sign": "AIdFcOQ9fbbU8VBr8GSmfoWQ6VfvSWLDi0RyUYSNVOXdVgN7lXVx4Y+0adD2fywctCz8qxEf5p7Sy34Zwi3nmKznhPpwAMlEPZyhgEBwRcozqF9qBQcKxi/o+yLNG1a4HDS6uJEXwgFl8yzju8+GjNIvBXi+wSJmmgs9hoK0V+V377KZuv/rUrSjefYru7I1IcV89vee3UfJxEZPL94DsLb6L0mROkQWe7ujI4NgZRtyUX68jlVpf2hu7HMWoQvyu/ypToJ7FbcVnKkJNOj9YJHVi9D9ZvcutZu7fLGPu8AslM4JQMFkcW/iZDUVJhmFuJJuxFcmpGoDT2f8O+8img==",
    "sn": "MXXXXXXXX",
    "signType": "RSA2",
    "data": {
    },
    "msg": "成功"
}

2.1 接口格式定义

1. 协议规则#

2. 公共参数#

2.1 通用报文格式#

2.2 报文示例#

1. 协议规则

2. 公共参数

2.1 通用报文格式

2.2 报文示例