今天完成的事

把接口文档写完了。

如下。

一、约定

前台接口约定

特殊code：

1、系统错误：-1

2、用户未登陆：-2

3、用户冻结：-3 

接口约定：

1、实名认证状态：

     0：未认证

     1：认证成功

2、银行卡类型：0-借记卡；1-信用卡

3、是否是默认银行卡：0--不是；1-是

4、用户状态：0：未提交实名申请  1：提交待认证 2：认证成功  3：取消认证，4：拒绝认证

5、article类型：

type=1：banner管理；

type=2：帮助中心管理；

type=3：关于我们；

type=4：版本管理；

后台接口约定

实名认证、运营管理、统计模块、版本更新、参数设置、银行限额、用户管理(改手机号、解绑银行卡、修改理财经理工号)

1、实名认证状态：0：未提交实名申请  1：提交待认证 2：认证成功  3：取消认证，4：拒绝认证

2、理财经理状态：0-停用；1–启用

3、用户状态：0–冻结用户；1–正常用户

后台：用户管理、债权管理、债权匹配、用户管理

1、请求参数的利率，统一传除以100之后的小数；返回参数的利率，统一是小数，没有按百分比格式化
2、金额类的参数，统一按数字传递，比如：5万或50,000这样格式的数字，都传50000
3、所有的status，请求参数传Number；返回数据，也是Number
4、返回的数据，如果是多个字符串拼接的，则用英文分号分割，前端直接split
5、所有的还款方式，类似：T+1/T+2之类，请求参数只需把1/2的数字传到后端就行；后端传前台也是1/2的数字，前端自己展示即可
6、
债权统一叫“债权”（credit），
产品或项目统一叫“产品”（product），
投资统一叫“投资”（invest），
投资的金额统一叫“本金”（principal），
收益统一叫“利息”（interest），
交易或订单流水统一叫“交易”（transact），
利率或年利率统一叫“年利率”（yearRate），
计息日或起息日统一叫“起息日”（interestStartAt），
结束日期或到息日统一叫“到息日”（interestEndAt），
以上是每个金融项目一般都会出现的概念，约定名称如上，方便前后端程序、人的交流

二、前台接口

 用户登录注册

1.用户注册

请求地址：post  /a/register

请求参数：

返回参数：

2.用户登录

请求地址：post  /a/login

请求参数：

返回参数

3.用户退出登录

请求地址：post  /a/u/logout

返回参数

4.忘记密码

请求地址：put  /a/password/forget

请求参数：

返回参数

5、修改密码(旧密码、新密码)

请求地址：put  /a/u/pwd

请求参数：

返回参数 :

我的账户

1、查询用户基本信息

请求地址：get  /a/u/user

返回参数：

baseInfo:

cardList的object:

bankList:

2、修改账户信息

请求地址：put   /a/u/user

请求参数：

返回参数：

理财模块：

1.理财（获取产品或推荐产品列表）

1. 请求地址：get  /a/product/search
   
   请求参数：

   字段	说明	类型	是否必填	备注
   type	类型	Number	否	0：产品列表；1：推荐产品列表，不传默认产品列表

   返回参数：

   字段	说明	类型
   code	状态码	Number
   message	返回信息	String
   data	返回数据	Object

   data：

   字段	说明	类型
   list	产品列表	Array

   list数组中单个元素：

   字段	说明	类型	备注
   id	产品ID	Number
   name	产品名称	String
   code	产品代码	String
   yearRate	预计年化	Number	比如：传的是“0.05“不是“5%”，前台自己转换一下
   timeLimitType	期限单位	Number	期限单位（0：月；1：天）
   monthLimit	理财期限	Number
   minAmount	起投金额	Number
   interestBeginAt	起息日	Number
   payBackType	还款方式	Number
   isRecommend	是否推荐	Number
   status	状态	Number
   tag	产品标签	String	标识该产品是“新”或其它等，以英文分号分割，比如：新;热
   isBuyLimit	是否限购	Number
   comment	备注	String

   2.产品详情

   请求地址：get  /a/product/{id}/detail

   请求参数：

   字段	说明	类型	是否必填	备注
   Id	产品ID	Number	是

   返回参数：

   字段	说明	类型
   code	状态码	Number
   message	返回信息	String
   data	返回数据	Object

   data：

   字段	说明	类型	备注
   id	产品ID	Number
   name	产品名称	String
   code	产品代码	String
   yearRate	预计年化	Number	比如：传的是“0.05“不是“5%”，前台自己转换一下
   timeLimitType	期限单位	Number	期限单位（0：月；1：天）
   monthLimit	理财期限	Number
   minAmount	起投金额	Number
   interestBeginAt	起息日	Number
   interestEndAt	到期日期	Number	已按月或按天算好的时间戳
   payBackType	还款方式	Number
   isRecommend	是否推荐	Number
   status	状态	Number
   tag	产品标签	String	标识该产品是“新”或其它等，以英文分号分割，比如：新;热
   isBuyLimit	是否限购	Number
   comment	备注	String

    

   3.续投列表

   请求地址：get  /a/u/continueInvest/search

   请求参数：无

   返回参数：

   字段	说明	类型
   code	状态码	Number
   message	返回信息	String
   data	返回数据	Object

   data：

   字段	说明	类型
   list	续投列表	Array

   list数组中单个元素：

   字段	说明	类型	备注
   Id	投资ID	Number
   productName	产品名称	String
   amount	投资本金	Number
   yearRate	预计年化	Number	比如：传的是“0.05“不是“5%”，前台自己转换一下
   interestBeginAt	起息日	Number
   interestEndAt	到息日	Number
   status	投资状态	Number
   productTag	产品标签	String	标识该产品是“新”或其它等，以英文分号分割，比如：新;热
   minAmount	起投额	Number
   monthLimit	期限值	Number
   timeLimitType	期限单位	Number
   productId	产品id	Number
   hasContinueInvest	是否已经续投过	Number	0：没有；1：续投过了

   4. “立即续投”按钮和续投“确定”按钮

   
   请求地址：get  /a/u/continueInvest/{id}

   请求参数：

   字段	说明	类型	是否必填	备注
   productId	产品ID	Number	是
   id	投资id	Number	是
   cardId	银行卡id	Number	是
   bankName	银行名字	Number	是
   cardNo	银行卡号	Number	是
   type	类型	String	是	"verify”表示立即续投按钮；"add"表示续投确定按钮

   返回参数：

   字段	说明	类型	备注
   code	状态码	Number	如果code是负30002，则表示该投资已经续投过了，不能再续投
   message	返回信息	String
   data	返回数据	Object

   data:

   字段	说明	类型
   id	订单id	Number
   productId	产品id	Number
   productName	产品名字	String
   productCode	产品代号	String
   yearRate	年利率	Number
   monthLimit	期限	Number
   minAmount	起投金额	Number
   interestBeginAt	产品起息日	Number
   payBackType	还款方式	Number
   userId	用户id	Number
   userName	用户姓名	String
   userIdNo	用户身份证号	String
   payType	付款方式	Number
   payNo	银行卡号	String
   payInfo	开户行名称	String
   payMobile	绑定手机号	String
   amount	订单金额	Number
   ordersNo	订单号	String
   status	订单状态	Number
   createAt	创建时间	Number
   contractNo	合同编号	String
   creditNo	债权编号	String
   signatureImg	签名图片	String

   5. 续投订单取消

   请求地址：put  /a/u/continueInvest/cancel

   请求参数：

   字段	说明	类型	是否必填	备注
   ordersId	订单ID	Number	是

   返回参数：

   字段	说明	类型	备注
   code	状态码	Number
   message	返回信息	String
   data	返回数据	Object

支付模块

（鉴于开发人员太穷了，这个模块取消）

我的资产模块

1.交易流水

请求地址：get /a/u/transact/search

请求参数：无

返回参数：

data：

list数组中单个元素：

2.我的投资

请求地址：get /a/u/invest/search

请求参数：

返回参数：

data：

list数组中单个元素：

3.投资详情

请求地址：get /a/u/invest/{id}/detail

请求参数：

返回参数：

data：

3.债权转让协议

这里按照原型图跳转到合同页，省去接口。

请求地址：get /a/u/investSplit/{investId}

investId：投资id

返回数据：code, message,data

data:

4.获取公章
 

请求地址：get  /a/constant/search

返回参数：

data:

======================================================================================================================================

三，后台接口

typeNo

typeInfo

参数设置

1、保存参数

请求地址：put   /a/u/constant

请求参数：

creditDeadlineDays

返回参数：

2、查看参数

请求地址：get  /a/constant/search

返回参数：

data:

creditDeadlineDays

银行限额管理

1、银行列表

请求地址：get   /a/bank/search

请求参数：

minSingleQuota

maxSingleQuota

minDailyQuota

maxDailyQuota

返回参数：

data:

list的object:

bankName

bankCode

2、新增

请求地址：post   /a/u/bank

请求参数：

bankCode

返回参数：

3、编辑

请求地址：post  /a/u/bank/{id}

请求参数：

bankCode

返回参数：