API对外接口文档示范 · wml_code

# 逸兔进件回调接入综述 ## **1 域名** * 测试环境：[http://api-dev-rx.pjpfljcw.com/](http://api-dev-rx.pjpfljcw.com/) * 生产环境：指定获取 ## **2 接入条件** > **密钥对** > > * 生成密钥对: ssh-keygen -m PEM -t rsa -b 4096 -f id_rsa > * 进行PKCS#8编码：openssl pkcs8 -topk8 -inform PEM -in id_rsa -outform pem -nocrypt -out private_key.pem > * 根据私钥生成公钥：openssl rsa -in private_key.pem -pubout -out public_key.pem * 合作机构申请APP_ID * 合作机构上传公钥 ### **2.1 请求格式** 统一采用`POST`，业务数据作为`Json Body`，content-type 固定为`application/json` ### **2.2 公共参数** 与业务无明显关系的统称为公共参数，包括并不限于签名、appId、请求时间等，通通置于Request Header中。 | 参数名 | 必传 | 备注 | | --- | --- | --- | | B-APP-ID | N（请求平台接口为必传） | appId（平台为各机构分配的AppId，对接时提供） | | B-SIGNATURE | Y | 请求签名 | | B-TIMESTAMP | Y | 时间戳，精确到毫秒 | ### **2.3签名方式** 所有请求都需要签名，签名算法为RSA加解密`(RSA/MD5withRSA)`MD5字符编码：utf-8签名方式为 Json序列化请求参数后使用私钥进行RSA签名 #### **2.3.1签名** 1 将业务参数转码成 `json` 字符串然后进行ASCII码排序 ``` { "type":3, "val":"20220222122218596" } ``` 2 使用自己生成的私钥 RSA加密`(RSA/MD5withRSA)` 业务参数生成签名 3 将生成的签名放置到 `Request Header` `B-SIGNATURE` 中 4 发送请求 ### **2.3.2验签** 1 将业务参数转码成 `json` 字符串然后进行ASCII码排序 ``` { "type":3, "val":"20220222122218596" } ``` 2 获取到请求头中的签名 3 使用公钥和签名进行RSA转码 ### 请求响应除明确说明外请求和返回的数据均为utf8编码，返回数据使用JSON格式，如： ~~~ { "code": 200, "msg": "", "data": { } } ~~~ 其中 code标示请求状态，200为操作成功，data 为具体的返回数据。其他状态码标示操作错误，msg会返回具体的错误信息 ### 其他说明 * 金额，统一单位元，保留两位小数 * 时间，统一13位时间戳，精确到毫秒 # API ## 1 审核状态 #### 请求Path POST`/api-public/loan-half/check-status` #### 请求参数 | 参数名 | 参数名称 | 参数类型 | 是否允许为空 | 备注 | | --- | --- | --- | --- | --- | | `code` | 审核状态 | int | 否 | 200: 成功 400:失败| | `msg` | 原因描述 | string | 否 | 审核失败时务必给出失败原因，成功时为‘审核成功’ | | `type` | 类型 | string | 否 | 1，2 ，3 更多请看 "val字段"| | `val` | 类型 | string | 否 | type=1 val值为手机号，type=2值为身份证号，type = 3值为进件时的订单号 | | `url` | app下载地址 | string | 是 | 审核成功时给出app下载的URL 失败时可为空字符串 ‘’| | `amount` | 授信金额 | int | 是 | 审核成功时设置放款金额，默认为0 | #### 2.4 响应参数 | 参数名 | 参数名称 | 参数类型 | 是否允许为空 | 备注 | | --- | --- | --- | --- | --- | | 无 | | | | | ###### 示例 * 成功 ~~~ { "code": 200, "msg":"success"， "data":{} } ~~~ ## 2 放款状态 #### 请求Path POST`/api-public/loan-half/amount-status` #### 请求参数 | 参数名 | 参数名称 | 参数类型 | 是否允许为空 | 备注 | | --- | --- | --- | --- | --- | | `loan_status` | 放款状态 | int32 | 否 | 200: 成功 400:失败| | `loan_result` | 原因描述 | string | 否 | 放款失败时务必给出失败原因，成功时为‘放款成功’ | | `type` | 类型 | int | 否 | 1，2 ，3 更多请看 "val字段"| | `val` | 类型 | string | 否 | type=1 val值为手机号，type=2值为身份证号，type = 3值为进件时的订单号 | | `url` | app下载地址 | string | 是 | 审核成功时给出app下载的URL 失败时可为空字符串 ‘’| | `amount` | 放款金额 | int | 是 | 审核成功时设置放款金额，默认为0 | #### 2.4 响应参数 | 参数名 | 参数名称 | 参数类型 | 是否允许为空 | 备注 | | --- | --- | --- | --- | --- | | 无 | | | | | ###### 示例 * 成功 ~~~ { "code": 200, "msg":"success"， "data":{} } ~~~