通用约定
Base URL(示例)
https://api.baofu.com实际前缀以环境配置为准;下列路径均为在网关之后的 相对路径。
必选 Header(按接口)
| Header | 说明 |
|---|---|
Baofu-Mch-ID |
统一会员编号;签约幂等、订阅/扣款查询等场景与业务主体绑定,查询类接口必填 |
Request-ID |
请求链路 ID,建议每次请求唯一 |
Baofu-Sign-Type |
签名算法类型(与网关验签约定一致) |
Mch-Serial-No |
商户侧证书序列号(签名用) |
Baofu-Serial-No |
宝付侧证书序列号(加密用) |
其他可选 Header(如 Baofu-Client-IP、X-Forwarded-For)以网关与风控要求为准。
Body 原则
- 业务参数使用 驼峰 命名。
- 统一会员标识、证书序列号、签名类型等已在网关 Header 中体现时,不要在 Body 重复传同名敏感元数据(与网关规范一致)。
统一响应
| 字段 | 类型 | 说明 |
|---|---|---|
success |
boolean | true 表示业务成功(HTTP 一般为 200) |
code |
string | 失败时的错误码;成功时为 null |
message |
string | 失败时的提示文案 |
data |
object | 成功时的业务载荷对象 |
成功示例:
{
"success": true,
"code": null,
"message": null,
"data": {
"subscriptionNo": "SP01010120260319120000000001",
"status": "ACTIVE"
}
}
失败示例:
`json
{
“success”: false,
“code”: “INVALID_PARAMETER”,
“message”: “参数校验失败说明”,
“data”: null
}
###