湖南省零檬信息技术有限公司
前程贷接口文档 1.0
版本号 版本日期 修改者
2017-5-18
Happy
2017-5-24
Nick
试
1.0
2.0
测
修订记录表
序号
1
2
新建文档
新加了会员相关接口
变更内容说明
件
软
班
檬
柠
让学习变得简单
第 1 页 共 10 页
1 接口说明
湖南省零檬信息技术有限公司
接口访问地址:
http://主机地址:端口号/futureloan/mvc/api/模块/接口名
本接口使用 RESTful API 的规范设计,返回结果的说明如下:
{
"status": 1, //接口执行状态,1 表示成功 0 表示异常
"code": ,"业务自定义状态码,无信息是为空字符串,status=1 时 code 为 10001,表示成功,
30204 表示第 3 模块第 2 个接口的第 4 个状态码,模块:用户 1,标 2,投资 3,回款计划 4,流水
记录 5",
"data": {
//返回数据、对象与数组均可,为空统一设置为NULL,基于其他客户端(如Java、Objective-C)
对空值(Null、nil、null)的处理空值不便或容易产生异常,可根据具体业务和前后端约定空数组
为[],空字典为{}
},
"msg": "该字段是本次请求的业务、状态描述信息,主要用于调试、测试等,status!=1
试
测
件
软
时都应该有错误信息,无信息是为空字符串"
}
班
1.1 用户
1.1.1 注册
接口地址:member/register
请求方式:GET/POST
檬
柠
变量名
mobilephone
pwd
regname
变量名
status
code
参数
手机号
密码
注册名
结果说明
参数
结果
返回码
类型
String
String
String
类型
String
String
说明
新会员的手机号
6 到 18 位(最少 6 位,最长 18 位)
相当于昵称
可否为空
否
否
是
说明
接口执行状态,1 表示成功 0 表示异常
10001:成功
20102:服务器异常
20103:参数错误:参数不能为空
20108:密码长度必须为 6~18
20109:手机号码格式不正确
20110:手机号码已被注册
让学习变得简单
第 2 页 共 10 页
湖南省零檬信息技术有限公司
1.1.2 登录
接口地址:member/login
请求方式:GET/POST
变量名
mobilephone
pwd
类型
String
String
说明
会员手机号
会员密码
可否为空
否
否
参数
手机号
密码
结果说明
参数
结果
返回码
变量名
status
code
类型
String
String
1.1.3 充值
接口地址:member/recharge
请求方式:GET/POST
参数
手机号
充值额度
结果说明
参数
结果
返回码
檬
柠
变量名
status
code
变量名
mobilephone
amount
类型
String
double
软
班
类型
string
string
试
说明
接口执行状态,1 表示成功 0 表示异常
10001:成功
20102:服务器异常
20103:参数错误:参数不能为空
20111:用户名或者密码错误
测
件
说明
可否为空
充值人的手机号
0 到 50 万之间的正数金额,最多精确到到
小数点后两位。
否
否
说明
接口执行状态,1 表示成功 0 表示异常
10001:成功
20102:服务器异常
20103:参数错误:参数不能为空
20104:此手机号对应的会员不存在
20109:手机格式不正确
20115:请输入金额
20116:输入金额的金额小数不能超过两位
20117:请输入范围在 0 到 50 万之间的正数金
额
20118:请输入数字
让学习变得简单
第 3 页 共 10 页
湖南省零檬信息技术有限公司
1.1.4 提现
接口地址:member/withdraw
请求方式:GET/POST
参数
手机号
提现金额
变量名
mobilephone
amount
类型
String
Double
说明
可否为空
取现人的手机号
0 到 50 万之间的正数金额,最多精确到到
小数点后两位。
否
否
试
测
说明
接口执行状态,1 表示成功 0 表示异常
10001:成功
20102:服务器异常
20103:参数错误:参数不能为空
20104:此手机号对应的会员不存在
20109:手机格式不正确
20115:请输入金额
20116:输入金额的金额小数不能超过两位
20117:请输入范围在 0 到 50 万之间的正数金
额
20118:请输入数字
20119: 余额不足,请修改提现额度
件
结果说明
参数
结果
返回码
变量名
status
code
类型
string
string
软
班
檬
1.1.5 获取用户列表
接口地址:member/list
请求方式:GET/POST
参数:无
柠
结果说明
参数
结果
返回码
变量名
status
code
类型
string
string
说明
接口执行状态,1 表示成功 0 表示异常
10001:成功
20102:服务器异常
让学习变得简单
第 4 页 共 10 页
1.1.6 投资、竞标(bidLoan)
接口地址:/member/bidLoan
请求方式:GET/POST
参数
用户 ID
密码
标 id
投资金额
结果说明
参数
结果
返回码
变量名
memberId
password
loanId
amount
变量名
status
code
类型
int
string
int
double
类型
string
string
软
班
檬
object
string
柠
data
msg
数据
信息
湖南省零檬信息技术有限公司
说明
可否为空
否
否
否
否
试
测
件
说明
接口执行状态,1 表示成功 0 表示异常
10001:竞标成功
11002:服务器异常
11003:参数错误:所有参数都不能为空
11004:参数错误,memberId 必须是大于 0 的
正整数
11005:参数错误,loanId 必须是大于 0 的正
整数
11006:参数错误,password 长度必须大于 6
位且小于 18 位
11007:参数错误,投资金额必须是能被 100
整除的正整数
11008:不存在该用户
11009:不存在该标的
11010:该标不在竞标中状态,无法完成投标
11011:该标已经满标,无法进行投资
11012:该标可投金额不足
11013:请根据数值参数的类型对应输入合法
的数字
让学习变得简单
第 5 页 共 10 页
1.2 项目
1.2.1 新增项目(add)
接口地址:/loan/add
请求方式:GET/POST
参数
用户 ID
标题
借款金额
年利率
变量名
memberId
title
amount
loanRate
loanTerm
借款期限
借款期限类型 loanDateType
还款方式
repaymemtWay
int
类型
int
string
double
double
int
int
软
类型
string
string
班
biddingDays
int
竞标天数
结果说明
参数
结果
返回码
檬
变量名
status
code
柠
数据
信息
data
msg
object
string
湖南省零檬信息技术有限公司
说明
可否为空
试
如年化 18.0%,存储为 18.0
如 6 个月为 6,30 天为 30
借 款 期限 单 位 0- 按 月 2- 按 天
4-按周
4-一次性 5 按月等额本息 10 按
月等额本息线下 11 按月付息到期
还本
1-10 天
测
件
否
否
否
否
否
否
否
否
说明
接口执行状态,1 表示成功 0 表示异常
10001:成功
20102:服务器异常
20103:参数错误:参数不能为空
20104:参数错误:用户 ID memberId 必须是
正整数
20105:不存在该会员
20106:参数错误:借款金额 amount 必须为
大于 1000 并能被 100 整除的正整数
20107:参数错误:借款利率 loanRate 值必
须大于 0 小于或等于 24
20108: 参 数 错 误 : 借 款 日 期 类 型
loanDateType 只能为 0,2,4
20109:参数错误:请根据参数类型对应输入,
数值类型只能输入数字
让学习变得简单
第 6 页 共 10 页
湖南省零檬信息技术有限公司
可否为空
否
否
试
1:审核中
2:二审(初审中)
3:三审(复审中)
4:竞标中
5:核保审批
6:平台终审
7:还款中
8:审核不通过
9:流标
10:还款完成
11:申请流标
测
件
说明
接口执行状态,1 表示成功 0 表示异常
10001:成功
20202:服务器异常
20203:参数错误:所有参数不能为空 20204:
参数错误:错误的标 id 值
20205:参数错误:非法 status 参数,状态值
1-11
20206:不存在该项目"
20207:修改失败,当前标已经是该状态
20208:审核不通过、流标、还款完成的标不
允许修改状态
20209:当前接口暂未开放该状态值更新
20210:不允许直接更新项目到还款中状态,
请执行生成回款计划
20211:当前接口暂未开放该状态值更新
20212:请根据参数类型对应输入,数值类型
只能输入数字
说明
1.2.2 审核(audit)
接口地址:/loan/audit
请求方式:GET/POST
参数
项目 ID
状态
变量名
id
status
类型
int
int
软
类型
string
string
班
结果说明
参数
结果
返回码
变量名
status
code
檬
柠
数据
信息
data
msg
object
string
让学习变得简单
第 7 页 共 10 页
湖南省零檬信息技术有限公司
1.2.3 获取标列表(getLoanList)
接口地址:/loan/getLoanList
请求方式:GET/POST
参数
变量名
类型
说明
可否为空
结果说明
参数
结果
返回码
数据
信息
变量名
status
code
data
msg
类型
string
string
object
string
1.2.4 生成回款计划(generateRepayments)
接口地址:/loan/generateRepayments
请求方式:GET/POST
件
说明
说明
接口执行状态,1 表示成功 0 表示异常
10001:获取标列表成功
20302:服务器异常
20303:获取标列表失败
试
测
可否为空
否
说明
接口执行状态,1 表示成功 0 表示异常
10001:生成回款计划成功
20402:服务器异常
20403:参数错误
20404:不存在该项目,生成回款计划失败
20405:该项目不在核保审批或终审状态,无
法生成回款计划
20406:请根据参数类型对应输入,数值类型
只能输入数字
参数
变量名
项目 id
id
结果说明
参数
结果
返回码
数据
信息
檬
变量名
status
code
柠
data
msg
软
类型
int
班
类型
string
string
object
string
让学习变得简单
第 8 页 共 10 页