接口格式

对于请求报文中的timestamp字段，请勿小于或大于当前时间15分钟
对于请求报文中的serialNo字段，请保证唯一

针对图片上传接口需要特殊处理，详见图片上传

1. 协议规则

协议版本：采用 HTTP/1.1

传输协议：采用 HTTPS

请求方式：统一使用 POST

数据格式：JSON

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

2. 通用请求报文格式

2.1请求示例

{
  "serialNo": "87912377819284756172",
  "version": "1.0",
  "timestamp": "1792573646112",
  "data": "{\"name\":\"test\"}",
  "signature": "FMWYWCotvTomwCKMj85h55wHyuFQv95HE/mjGNkiyouMcjiPrOhsBaeFSISDRlcVKrEQdEBn6KbNqj1syA/CNtk20QY8V58bpXzU1f71LANmPwk4YFpXNdM8TcyBLqyMTG0mxKL2JAv6sO8G9xmty0cudf3tqMKIDxYAtyG6pqUtpVrU4LDR6nkiv7KlWYkrdApvcSmj6ih6Cth0/BK3uBNQwdKX0fuMeN5l4sgAWnhAWkNn/wWls+RIucU4eBEakWz9OnhVXlt9YTOi/UpTUb0mnlx4FyQ6AXyR4mr0Sp9UaJWpah0xF4RNaMg41Apn0VkK0+RGypBaMJWQ7Pyu/A==",
  "appId": "888888"
}

2.2请求字段说明

字段名	类型	必填	说明
serialNo	String(32)	Y	请求流水号，保证唯一
version	String(10)	N	版本号，默认1.0
timestamp	String	Y	当前请求毫秒级时间戳
data	String	Y	业务数据(JSON字符串)
signature	String	Y	签名值
appId	String(6)	Y	服务商号

3.通用响应体格式

3.1响应示例

{
  "data": "{\"name\":\"test\"}",
  "signature": "PVRaWsysbw2ydBlAjcgFZBy3TcfDT85IYjBkTOhkosdJSQm9V63Wwikd2W9Hxck59udk4y6qMRADFPrm1qnU97+RZ/vDY2r1IkSMJFp/lWM6oq387hZvsf7UY9hNHZLk2MNy3ald1GkI3BCf+rEtYNrrnjp3S8uAdj+gXgkd3ke6XADN6p9LHu5+TGAMnIEV0iEAjEq6MC8y0+Yt5KH+ugh6RITchzAbyVUt7MfKG4ZuDMQ8DIALXVIWvsmL6YUtlbpce/2JFoC8Tj6K0u6taRMmzcg3Cg9k3apJ48ad9ZfVRF2VSXr5kBJyiS7xKXTED4O8k0L7+vOHxMG6odwNAg==",
  "code": "0000",
  "msg": "调用成功",
  "traceId": "c3999a4d4dd8489c904a41b04d55ddc2"
}

3.2响应字段说明

字段名	类型	必填	说明
data	String	N	业务数据(JSON字符串)
signature	String	Y	签名值
code	String	Y	响应码
msg	String	N	响应描述
traceId	String	Y	链路id

4.请求头

4.1请求头示例

Content-Type: application/json
Sign-Algorithm: RSA

4.2请求头字段说明

字段名	类型	必填	说明
Sign-Algorithm	String	N	可选值为RSA

5.统一返回码

返回码	返回码释义	说明
0000	调用成功	接口调用成功，业务处理成功
9999	系统错误	接口调用成功，业务处理失败
OPG105000	服务器开小差了，请稍后再试	系统内部错误
OPG104000	请求参数错误	缺少必填参数
OPG104030	无权限访问	机构不存在
OPG104031	当前IP未配置白名单，禁止访问	请先配置ip白名单
OPG104032	验签失败	验签失败
OPG104033	当前机构已被禁用，请联系对接人员	机构已被禁用
OPG104001	请求时间戳格式错误	输入正确格式的时间戳
OPG104002	请求时间戳超出允许范围	请求时间戳不允许跨跃当前时间15分钟
OPG104003	未找到数据签名服务	不受支持的签名算法

6.回调通用请求体格式

6.1请求示例

{
  "data": "{\"name\":\"test\"}",
  "signature": "PVRaWsysbw2ydBlAjcgFZBy3TcfDT85IYjBkTOhkosdJSQm9V63Wwikd2W9Hxck59udk4y6qMRADFPrm1qnU97+RZ/vDY2r1IkSMJFp/lWM6oq387hZvsf7UY9hNHZLk2MNy3ald1GkI3BCf+rEtYNrrnjp3S8uAdj+gXgkd3ke6XADN6p9LHu5+TGAMnIEV0iEAjEq6MC8y0+Yt5KH+ugh6RITchzAbyVUt7MfKG4ZuDMQ8DIALXVIWvsmL6YUtlbpce/2JFoC8Tj6K0u6taRMmzcg3Cg9k3apJ48ad9ZfVRF2VSXr5kBJyiS7xKXTED4O8k0L7+vOHxMG6odwNAg==",
  "code": "0000",
  "msg": "调用成功"
}

6.2请求字段说明

字段名	类型	必填	说明
data	String	N	业务数据(JSON字符串)
signature	String	Y	签名值
code	String	Y	响应码
msg	String	N	响应描述

1. 协议规则#

2. 通用请求报文格式#

2.1请求示例#

2.2请求字段说明#

3.通用响应体格式#

3.1响应示例#

3.2响应字段说明#

4.请求头#

4.1请求头示例#

4.2请求头字段说明#

5.统一返回码#

6.回调通用请求体格式#

6.1请求示例#

6.2请求字段说明#

1. 协议规则

2. 通用请求报文格式

2.1请求示例

2.2请求字段说明

3.通用响应体格式

3.1响应示例

3.2响应字段说明

4.请求头

4.1请求头示例

4.2请求头字段说明

5.统一返回码

6.回调通用请求体格式

6.1请求示例

6.2请求字段说明