【流程规范】API接口文档规范

接口名称

前置主动还款申请(/payBill)

接口描述

接口地址:https://api.yidianfenqi.net/payBill

返回格式:json

请求方式:GET/ POST

请求示例:https://api.yidianfenqi.net/payBill?key=123456&qq=654321;

接口备注:根据传入的key和qq号码发起还款的申请


请求参数说明(入参)

参数名 类型 说明 举例 必选
key int 用户的key 123456 Yes
qq long 用户的qq号码 654321 No

返回参数说明(出参)

参数名 类型 说明 举例
error_code int 返回的状态码 0
reason string 返回原因 “用户不存在”
result int 成功状态 1

JSON返回示例:

{
    "error_code": 0,//返回状态码
    "reason": "success",//返回原因
    "result": "1"//成功状态
}

错误码参照

服务级错误码参照

错误码 说明
211601 请求返回无结果
216602 无参数或格式不正确

系统级错误码参照

错误码 说明
10001 错误的请求KEY
10002 该KEY无请求权限
10003 KEY过期
10007 未知的请求源

错误码格式说明(示例:200201)

2 002 01
服务级错误(1为系统级错误) 服务模块代码(即数据ID) 具体错误代码

猜你喜欢

转载自blog.csdn.net/hbmovie/article/details/80940622