发表于: 2018-03-13 23:02:55

1 647


今日完成

1.前台接口文档的完成。

前台接口文档

特殊code

接口约定:

用户登录、注册、认证

1. 发用验证码

请求地址:Post    /a/code/send

请求参数:

字段

说明

类型

是否必填

备注

phoneNum

注册手机号码

String

 -

type

验证码类型

String

register:注册验证码

password:找回密码验证码

测试用万能验证码:555555

返回参数

字段

说明

类型

code

状态码

Integer

message

消息

String

2.用户注册

请求地址:post  /a/user/register

请求参数:

字段

说明

类型

是否必填

备注

phoneNum

注册手机号码

number

 

verify

验证码

String

 

pswd

密码

String

 

managerNum

理财经理工号

String

 


返回参数:

字段

说明

类型

code

状态码

number

message

消息

string

3.用户登录

请求地址:Post  /a/login

请求参数:

字段

说明

类型

是否必填

备注

phoneNum

注册手机号码

number

 

pswd

密码

String

 


返回参数

字段

说明

类型

code

状态码

number

message

消息

string

4.用户退出登录

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

返回参数

字段

说明

类型

code

状态码

number

message

消息

string

5.找回密码

请求地址:put  /a/user/forget

请求参数:

字段

说明

类型

是否必填

备注

mobile

注册手机号码

number

 

verify

验证码

String

 

pswd

密码

String

 

 

返回参数

字段

说明

类型

code

状态码

number

message

消息

string

6.修改密码

请求地址:Put  /a/u/user/pswd

请求参数:

字段

说明

类型

备注

userId

用户id

Long

 

oldPswd

旧密码

Number

 

newPswd

新密码

Number

 

返回参数 :

字段

说明

类型

备注

code

错误代码

Number

 

message

错误信息

String

 

7.实名认证

请求地址 Put /a/u/user/identify/{userId}

请求参数:

字段

说明

类型

是否必填

备注

name

真实姓名

String

 

IDCard

身份证号

String

 

idFront

正面

String

 

idBack

反面

String

 

返回参数:

字段

说明

类型

备注

code

状态码

number

 

message

消息

string

 

8.用户账户设置

请求地址:put   /a/u/user/set/{userId}

请求参数:

字段

说明

类型

是否必填

备注

email

电子邮箱

String

 

address

详细地址

String

 

 

返回参数:

字段

说明

类型

备注

code

状态码

number

 

message

消息

string

 

 

9.修改默认银行卡

请求地址:put   /a/u/user/bank/{userId}

请求参数:

字段

说明

类型

是否必填

备注

userBankId

默认用户银行卡id

String

 

 

返回参数:

字段

说明

类型

备注

code

状态码

number

 

message

消息

string

 

我的账户

1.   账户详情

请求地址:Get  /a/u/user/detail/{userId}

返回参数:

字段

说明

类型

备注

code

状态码

number

 

message

消息

string

 

baseInfo

用户基本信息

Object

 

baseInfo:

字段

说明

类型

备注

accountsStatus

帐户状态

Number

 

name

真实姓名

String

 

totalProperty

总资产

Number

 

income

累计收益

Number

 

2.   查询用户银行卡列表

请求地址:Get  /a/u/userBank/list/{userId}

返回参数:

字段

说明

类型

备注

code

状态码

number

 

message

消息

string

 

data

用户银行卡

Array

 

data:

字段

说明

类型

备注

userBankId

用户银行卡ID

number

 

bankName

开户行名称

number

 

CardNo

卡号

 String

前四位+后三位;中间用星号

logoPic

开户行LOGO

 String

 

SingleTransactionLimit

单笔限额

 String

 (单位:万元)

DailyLimit

日限额

 String

 (单位:万元)

3.   查询用户银行卡详情

4.    请求地址:Get  /a/u/userBank/{ userBankId}

5.    返回参数:

字段

说明

类型

备注

code

状态码

number

 

message

消息

string

 

data

用户银行卡

Array

 

6.      data:

字段

说明

类型

备注

id

开户行ID

number

 

bankName

开户行名称

number

 

CardNo

卡号

 String

前四位+后三位;中间用星号

logoPic

开户行LOGO

 String

 

SingleTransactionLimit

单笔限额

 String

 (单位:万元)

DailyLimit

日限额

 String

 (单位:万元)

 

7.   用户交易流水列表

请求地址:Get /a/u/tradingRecord/list/{userId}

请求参数:

字段

说明

类型

是否必填

备注

page

页数

number

 

 

size

页长

number

 

 

 

返回参数:

字段

说明

类型

code

状态码

Number

message

返回信息

String

data

数据

Array

data

字段

说明

类型

备注

tradingRecordId

交易表ID

number

 

tradingAmount

交易金额

number

 

productName

产品名称

String

 

tradingTime

交易时间

number

 

tradingStatus

交易状态

number

 

tradingType

交易类型

number

 

8.   用户交易流水详情

调用接口  GET  /a/u/ tradingRecord /{ tradingRecordId }

请求参数 

字段

说明

类型

是否必填

备注

tradeId

交易表ID

number

 


返回参数

字段

说明

类型

备注

code

MESSAGE

number

 

message

状态信息

String

 

data

数据

Object

 

data

字段

说明

类型

备注

tradingNum

交易流水号

String

 

tradingAmount

交易金额

number

 

productName

产品名称

String

 

tradingMode

交易方式(银行,尾号)

String

 

tradingTime

交易时间

number

 

tradingStatus

交易状态

number

见字段约定

tradingType

交易类型

number

见字段约定

9.   用户投资记录列表

调用接口  GET  /a/u/ investRecord /list/{userId}

请求参数 

字段

说明

类型

是否必填

备注

page

页数

number

 

 

size

页长

number

 

 

investStatus

投资状态

number

见约定

返回参数

字段

说明

类型

备注

code

MESSAGE

number

 

message

状态信息

String

 

data

数据

Array

 

data

字段

说明

类型

备注

investRecordId

投资记录表id

number

 

productName

产品名称

String

 

investAmount

投资本金

number

 

productInterestRate

年化收益率

number

 

valueDay

投资起息日期

number

 

valueEndDay

投资到期日期

number

 

investStatus

投资状态

number

见字段约定

flag

角标

number

见字段约定

6. 用户投资记录详情

调用接口  GET  /a/u/ investRecord /{ investRecordId}

请求参数 

字段

说明

类型

是否必填

备注

investRecordId

投资记录表id

number

 


返回参数

字段

说明

类型

备注

code

MESSAGE

number

 

message

状态信息

String

 

data

数据

Object

 

data

 

字段

说明

类型

备注

productName

产品名称

String

 

productInterestRate

年化收益率

number

 

investAmount

投资本金

number

 

valueDay

投资起息日期

number

 

valueEndDay

投资到期日期

number

 

productPaymentMethod

还款方式

number

见字段约定

repaymentBank

付款银行

String

 

repaymentCard

付款银行卡号

String

 

productInterestAmountLine

起投金额

number

 

investStatus

投资状态

number

 见字段约定

limited

产品限购

number

 

undistributedIncome

未分配收益

number

 

distributionIncome

已分配收益

number

 

7.查询平台可用银行卡列表

调用接口  GET  /a/u/bankList/list

请求参数 

字段

说明

类型

是否必填

备注

page

页数

number

 

 

size

页长

number

 

 


返回参数

字段

说明

类型

备注

code

MESSAGE

number

 

message

状态信息

String

 

data

数据

Array

 

 

data

字段

说明

类型

备注

bankListId

银行表ID

number

 

name

银行名称

String

 

logo_pic

logo(图片url)

String

 

 

理财、产品、支付

1.查询产品列表

调用接口  GET  /a/product/list

请求参数 

字段

说明

类型

是否必填

备注

recommended

是否精品推荐

number

见字段约定 

page

页数

number

 

 

size

页长

number

 

 

productStatus

产品状态

number

见字段约定

 

返回参数

字段

说明

类型

备注

code

MESSAGE

number

 

message

状态信息

String

 

data

数据

Array

 

data

字段

说明

类型

备注

productId

自增长ID

number

 

name

产品名称

String

 

interestRate

年化收益率

number

 

basicCapitalAmount

起投金额

number

 

financialPeriodDay

理财期限(天)

number

以天为单位

flag

角标

number

见字段约定

recommended

精品推荐

number

见字段约定

 

2.查询产品详情

调用接口  GET  /a/product/{id}

请求参数 

字段

说明

类型

是否必填

备注

productId

产品ID

number

 


返回参数

字段

说明

类型

备注

code

MESSAGE

number

 

message

状态信息

String

 

data

数据

Object

 

data

字段

说明

类型

备注

productId 

产品表ID 

number 

 

name

产品名称

String

 

interestRate

年化收益率

number 

 

paymentMethod

还款方式

number 

 见字段约定

interestAmountLine

起投金额

number 

 

interestDelayed

起息方式

number 

 见字段约定

financialPeriodDay

理财期限(天)

number 

以天为单位

financialPeriodMonth

理财期限(月)

number 

以月为单位:

remark

备注(50字以内)

String

长度不超过50

detailsPic

更多详情(图片url)

String

图片URL

flag

角标

number 

见字段约定

recommended

精品推荐

number 

见字段约定

limited

是否限购

number 

见字段约定

3.用户支付接口

 

4.用户产品续投列表

调用接口  GET  /a/u/ investRecord /again/{userId}

请求参数 

字段

说明

类型

是否必填

备注

page

页数

number

 

 

size

页长

number

 

 

返回参数

字段

说明

类型

备注

code

MESSAGE

number

 

message

状态信息

String

 

data

数据

Array

 

data

字段

说明

类型

备注

investRecordId

投资记录表id

number

 

productName

产品名称

String

 

investAmount

投资本金

number

 

productInterestRate

年化收益率

number

 

valueDay

投资起息日期

number

 

valueEndDay

投资到期日期

number

 

flag

角标

number

见字段约定

5.产品续投

调用接口  POST /a/u/product/reinvestment

请求参数 

字段

说明

类型

是否必填

备注

investRecordId

投资记录ID

number

是 

 


返回参数

字段

说明

类型

备注

code

MESSAGE

number

 

message

状态信息

String

 

 

内容、帮助、意见反馈

1.查询内容(帮助)列表

调用接口  GET /a/content/list

请求参数 

字段

说明

类型

是否必填

备注

type

类型

number

 

 具体见字段约定

status

状态

number

 

 具体见字段约定

page

页数

number

 

 

size

页长

number

 

 


返回参数

字段

说明

类型

备注

code

MESSAGE

number

 

message

状态信息

String

 

data

数据

Array

 

 

data

字段

说明

类型

备注

id

内容列表ID

number

 

title

标题

String

 

type

类型

number

具体见字段约定 

status

状态

number

具体见字段约定 

contentCoverPic

内容封面

String

 

contentPic

内容详情

String

 

2.意见反馈

调用接口  POST /a/u/suggestion

请求参数 

字段

说明

类型

是否必填

备注

userId

用户Id

String

 

suggestionDetail

意见内容

String

 


返回参数

字段

说明

类型

备注

code

MESSAGE

number

 

message

状态信息

String

 

id

新增意见记录ID

number

 

 

明日计划

1.后台接口文档

遇到问题

1.一些细节问题

收获

后台接口文档



返回列表 返回列表
评论

    分享到