1.1 接口格式定义

1. 协议规则

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

传输方式：HTTP 1.1-2.0 采用安全认证头的证明方式

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

数据格式：JSON

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

签名算法：参见下篇《2.2加签验签说明》

签名要求：根据具体接口要求

拦截校验逻辑：身份认证与接口权限校验（请求头中传输X-Api-Key，由收呗签发）、请求体校验，白名单校验、签名校验

2. 公共参数

联调环境通用参数


HTTP请求header中传输api-key：

1、测试环境api-key：
代理商：AK-0bf4488ad8eb464da0d6ff5816721f01
品牌商：
2、商用环境api-key：收呗注册商户后，系统分配

2.1 通用报文格式

请求报文格式

参数名称	含义	必填项	备注
请求头
api-key	API KEY（收呗签发）	Y	请求头必填
请求体
requestId	请求ID	Y	用于问题追踪，建议用UUID
timestamp	时间戳（毫秒）	Y
nonce	随机字符串	Y	长度须在 16-36 字符之间,仅允许字母、数字、下划线和短横线，建议用UUID
sign	签名	Y	参照2.2
reqBody	请求参数体

应答报文格式

参数名称	含义	必填项	备注
应答参数
code	响应状态码	Y	200成功，其他为错误码
msg	错误消息	N	条件域
timestamp	签名时间戳	Y
sign	签名	Y	参照2.2
nonce	随机字符串	Y
rspBody	响应参数体	C

2.2 报文示例

请求报文

{
   "requestId": "874df5e8-e90a-46a7-a8ec-982d8a448257",    
   "timestamp": "20221108121212", 
   "nonce": "e0845364-816a-405d-a3ee-044faa1517a4", 
   "sign": "签名", 
   "reqBody": 请求参数体
} 

注意：请求头中请携带api-key

应答报文

{
    "code": "200",
    "msg": "请求成功",    
    "timestamp": "20221108121212", 
    "nonce": "e0845364-816a-405d-a3ee-044faa1517a4", 
    "sign": "签名", 
    "rspBody": {
        "orderNo": "O202406010001",
        "status": "SUCCESS"
     }
}

2.1接口格式定义

1.1 接口格式定义#

1. 协议规则#

2. 公共参数#

联调环境通用参数#