完整word版用户端接口文档.docx

完整word版用户端接口文档.docx

《完整word版用户端接口文档.docx》由会员分享，可在线阅读，更多相关《完整word版用户端接口文档.docx（46页珍藏版）》请在冰豆网上搜索。

完整word版用户端接口文档

用户端接口文档-詹亚磊2017/01/05

版本记录

版本记录

日期

提交人

备注

V1.0

2017-01-05

詹亚磊

APP（魅客用户端）接口文档

登录模块

1、用户登录接口

接口说明

接口描述

用户登录接口

访问地址

/user/free/login.do

请求方式

GET/POST

请求格式

JSON

返回格式

JSON

开发人

詹亚磊

备注

用户第一次登录则进行注册，返回用户信息

请求参数说明

请求参数名

必填

类型

请求参数说明

cid

true

String

个推cid

userAccount

true

string

登录信息（手机号或微信账号）

type

true

int

登录类型（是手机号登录还是第三方微信登录1：

phone登录，2：

wechat登录）

nickName

false

string

微信注册（或登录）时获取的微信昵称

photo

false

string

微信注册（或登录）时获取的微信头像

返回结果说明

返回参数

参数类型

返回参数说明

单个对象数据

code

int

返回码

msg

string

返回信息

data

MmUser

Model模型

返回码说明

返回码（reponse_code）

说明

200

请求成功

400

请求失败（登录信息有误！

）

2、用户免登录接口

接口说明

接口描述

用户免登录接口

访问地址

/user/free/autoLogin.do

请求方式

GET/POST

请求格式

JSON

返回格式

JSON

开发人

陈天兰

备注

用户免登录

请求参数说明

请求参数名

必填

类型

请求参数说明

userId

true

int

用户id

token

true

string

用户token（token在json请求数据中传递）

返回结果说明

返回参数

参数类型

返回参数说明

单个对象数据

code

int

返回码

msg

string

返回信息

data

MmUser

Model模型

返回码说明

返回码（reponse_code）

说明

200

请求成功

400

请求失败（免登录信息有误！

）

3、用户退出接口

接口说明

接口描述

用户退出接口

访问地址

/user/logout.do

请求方式

GET/POST

请求格式

JSON

返回格式

JSON

开发人

刘辉

备注

用户退出登录，清空token

请求参数说明

请求参数名

必填

类型

请求参数说明

userId

true

int

当前用户ID

token

true

string

用户携带的token

返回结果说明

返回参数

参数类型

返回参数说明

单个对象数据

code

int

返回码

msg

string

返回信息

data

int

更新影响条数（row=1退出成功，row<1失败）

返回码说明

返回码（reponse_code）

说明

200

请求成功

400

请求失败（退出登录有误！

）

首页模块

4、首页根据等级展示接口

接口说明

接口描述

首页等级排序接口

访问地址

/user/free/gradeList.do

请求方式

GET/POST

请求格式

JSON

返回格式

JSON

开发人

詹亚磊

备注

（显示所有通过审核且在服务状态的妹子）等级降序

请求参数说明

请求参数名

必填

类型

请求参数说明

pageNumb

true

int

当前页码（从1开始，第几页）

lat

true

string

用户当前维度

lag

true

string

用户当前经度

返回结果说明

返回参数

参数类型

返回参数说明

Map对象数据

code

int

返回码

msg

string

返回信息

babyList

List

Model模型

bannerList

List

Model模型

返回码说明

返回码（reponse_code）

说明

200

请求成功

400

请求失败（没有查询到妹子信息）

5、首页根据距离展示接口

接口说明

接口描述

首页距离排序接口

访问地址

/user/free/distanceList.do

请求方式

GET/POST

请求格式

JSON

返回格式

JSON

开发人

詹亚磊

备注

（显示所有通过审核且在服务状态的妹子）与用户距离降序

请求参数说明

请求参数名

必填

类型

请求参数说明

pageNumb

true

int

当前页码（从1开始，第几页）

lat

true

string

用户当前维度

lag

true

string

用户当前经度

返回结果说明

返回参数

参数类型

返回参数说明

Map对象数据

code

int

返回码

msg

string

返回信息

babyList

List

Model模型

bannerList

List

Model模型

返回码说明

返回码（reponse_code）

说明

200

请求成功

400

请求失败（没有查询到妹子信息）

6、首页根据注册时间最新展示接口

接口说明

接口描述

首页最新列表接口

访问地址

/user/free/newList.do

请求方式

GET/POST

请求格式

JSON

返回格式

JSON

开发人

詹亚磊

备注

（显示所有通过审核且在服务状态的妹子）审核时间降序

请求参数说明

请求参数名

必填

类型

请求参数说明

pageNumb

true

int

当前页码（从1开始，第几页）

lat

true

string

用户当前维度

lag

true

string

用户当前经度

返回结果说明

返回参数

参数类型

返回参数说明

Map对象数据

code

int

返回码

msg

string

返回信息

babyList

List

Model模型

bannerList

List

Model模型

返回码说明

返回码（reponse_code）

说明

200

请求成功

400

请求失败（没有查询到妹子信息）

7、首页默认展示接口

接口说明

接口描述

默认主页显示（妹子信息）

访问地址

/user/free/gradeList.do

请求方式

GET/POST

请求格式

JSON

返回格式

JSON

开发人

詹亚磊

备注

请求参数说明

请求参数名

必填

类型

请求参数说明

pageNumb

true

int

当前页码（从1开始，第几页）

lat

true

string

用户当前维度

lag

true

string

用户当前经度

返回结果说明

返回参数

参数类型

返回参数说明

Map对象数据

code

int

返回码

msg

string

返回信息

babyList

List

Model模型

bannerList

List

Model模型

返回码说明

返回码（reponse_code）

说明

200

请求成功

400

请求失败（没有查询到妹子信息）

8、首页-筛选查询接口

接口说明

接口描述

首页筛选查询（根据年纪、身高、体重、金额条件查询）

访问地址

/user/free/filtrateBaby.do

请求方式

GET/POST

请求格式

JSON

返回格式

JSON

开发人

詹亚磊

备注

（显示所有通过审核且在服务状态的妹子）按服务价格（等级）降序、和用户距离升序排列

请求参数说明

请求参数名

必填

类型

请求参数说明

pageNumb

true

int

当前页码（从1开始）

lat

true

string

用户当前维度

lag

true

string

用户当前经度

maxAge

true

int

年龄上限

minAge

true

int

年龄下限

maxHeight

true

int

身高上限

minHeight

true

int

身高下限

maxWeight

true

int

体重上限

minWeight

true

int

体重下限

maxGradePrice

true

double

服务价格上限

minGradePrice

true

double

服务价格下限

测试数据--请求参数：

json={"pageNumb":

"1","lat":

"30.19","lag":

"120.21","maxAge":

"24","minAge":

"13","maxHeight":

"170","minHeight":

"150","maxWeight":

"50",

"minWeight":

"40","maxGradePrice":

"1500","minGradePrice":

"600"}

返回结果说明

返回参数

参数类型

返回参数说明

Map对象数据

code

int

返回码

msg

string

返回信息

babyList

List

Model模型

bannerList

List

Model模型

返回码说明

返回码（reponse_code）

说明

200

请求成功

400

请求失败（没有查询到妹子信息）

9、显示妹子详细信息接口

接口说明

接口描述

显示妹子详细信息

访问地址

/user/free/babyDetail.do

请求方式

GET/POST

请求格式

JSON

返回格式

JSON

开发人

詹亚磊

备注

显示妹子详细信息（包括评价分数及当前用户对妹子的关注状态）

请求参数说明

请求参数名

必填

类型

请求参数说明

userId

true

int

当前用户Id

babyId

true

int

所选妹子Id

返回结果说明

返回参数

参数类型

返回参数说明

Map对象数据

code

int

返回码

msg

string

返回信息

baby

MsBaby

所有妹子信息（Model对象）

rateAvg

double

妹子的评价平均分

isAttention

int

当前用户对该妹子的关注状态

返回码说明

返回码（reponse_code）

说明

200

请求成功

400

请求失败（没有查询到妹子详细信息）

10、关注妹子接口

接口说明

接口描述

用户关注妹子（已关注则取消，未关注则加关注）

访问地址

/user/attention.do

请求方式

GET/POST

请求格式

JSON

返回格式

JSON

开发人

詹亚磊

备注

已关注则取消关注，未关注则加关注

请求参数说明

请求参数名

必填

类型

请求参数说明

userId

true

int

用户ID

babyId

true

int

所选妹子ID

isAttention

true

int

用户对所选妹子的关注状态（是否关注，显示妹子详情时已返回前端）

token

true

string

用户登录成功返回的token

返回结果说明

返回参数

参数类型

返回参数说明

单个对象数据

code

int

返回码

msg

string

返回信息

data

int

用户对所选妹子的关注状态（isAttention）

返回码说明

返回码（reponse_code）

说明

200

请求成功

400

请求失败（各种消息语）

11、约会接口（点击约她）

接口说明

接口描述

填写订单

访问地址

/user/invite.do

请求方式

GET/POST

请求格式

JSON

返回格式

JSON

开发人

詹亚磊

备注

填写订单页面需要显示的妹子信息

请求参数说明

请求参数名

必填

类型

请求参数说明

babyId

true

int

所选妹子ID

token

true

string

用户登录成功返回的token

返回结果说明

返回参数

参数类型

返回参数说明

单个对象数据

code

int

返回码

msg

string

返回信息

data

MkOrderDetail

Model模型

返回码说明

返回码（reponse_code）

说明

200

请求成功

400

请求失败（请求失败，没有获取到妹子信息）

排行榜模块

12、人气排行榜接口

接口说明

接口描述

显示妹子人气排行榜

访问地址

/user/free/popularList.do

请求方式

GET/POST

请求格式

JSON

返回格式

JSON

开发人

詹亚磊

备注

按妹子已约单数降序排序

请求参数说明

请求参数名

必填

类型

请求参数说明

pageNumb

true

int

当前页数（第几页，从1开始）

返回结果说明

返回参数

参数类型

返回参数说明

List对象数据

code

int

返回码

msg

string

返回信息

data

List

Model模型

返回码说明

返回码（reponse_code）

说明

200

请求成功

400

请求失败（没有查询到人气榜单信息）

13、信誉排行榜接口

接口说明

接口描述

信誉排行榜

访问地址

/user/free/creditList.do

请求方式

GET/POST

请求格式

JSON

返回格式

JSON

开发人

詹亚磊

备注

按妹子评价分降序排序

请求参数说明

请求参数名

必填

类型

请求参数说明

pageNumb

True

int

当前页数（第几页，从1开始）

返回结果说明

返回参数

参数类型

返回参数说明

List对象数据

code

int

返回码

msg

string

返回信息

data

List

Model模型

返回码说明

返回码（reponse_code）

说明

200

请求成功

400

请求失败（没有查询到信誉榜信息）

用户端订单模块

14、获取支付宝相关的KEY配置接口

接口说明

接口描述

返回阿里支付相关的key配置

访问地址

/alipay/keys.do

请求方式

GET/POST

请求格式

JSON

返回格式

JSON

开发人

詹亚磊

备注

请求参数说明

请求参数名

必填

类型

请求参数说明

token

true

string

token

返回结果说明

返回参数

参数类型

返回参数说明

Map对象数据

code

int

返回码

msg

string

返回信息

alipayPartner

string

alipayPrivateKey

string

私钥

alipayPublicKey

string

公钥

alipayOrderNotifyUrl

string

回调地址

alipayRechargeNotifyUrl

string

返回码说明

返回码（reponse_code）

说明

200

请求成功

400

请求失败（请求失败，没有获取到妹子信息）

15、妹子是否有订单状态检查接口

接口说明

接口描述

当前所选妹子是否已被抢走

访问地址

/userOrder/haveOrder.do

请求方式

GET/POST

请求格式

JSON

返回格式

JSON

开发人

詹亚磊

备注

妹子当前是否在订单状态

请求参数说明

请求参数名

必填

类型

请求参数说明

babyIdList

true

List

所选所有妹子的ID

token

true

string

用户登录成功返回的token

json={"babyIdList":

[106,107,108,109]}

返回结果说明

返回参数

参数类型

返回参数说明

Map对象数据

code

int

返回码

msg

string

返回信息

haveOrder

boolean

是否有被抢单的妹子（true-有妹子已被抢走）

cancleBabyList

List

被抢单的妹子的信息

返回码说明

返回码（reponse_code）

说明

200

请求成功

400

请求失败（请求失败，没有获取到妹子信息）

16、支付检查接口（支付之前调用，更改妹子为有订单状态）

接口说明

接口描述

支付之前调用，更改妹子为有订单状态

访问地址

/userOrder/payCheck.do

请求方式

GET/POST

请求格式

JSON

返回格式

JSON

开发人

詹亚磊

备注

妹子当前是否在订单状态

请求参数说明

请求参数名

必填

类型

请求参数说明

babyIdList

true

List

所选所有妹子的ID

token

true

string

用户登录成功返回的token

json={"babyIdList":

[106,107,108,109]}

返回结果说明

返回参数

参数类型

返回参数说明

Map对象数据

code

int

返回码

msg

string

返回信息

cancleBabyList

List

如果所选妹子中有已被抢单的，则返回被抢单的妹子信息

返回码说明

返回码（reponse_code）

说明

200

请求成功

400

请求失败

17、用户支付失败，更新妹子订单状态接口

接口说明

接口描述

用户支付失败，更新所选妹子的订单状态为无订单

访问地址

/userOrder/payFail.do

请求方式

GET/POST

请求格式

JSON

返回格式

JSON

开发人

詹亚磊

备注

请求参数说明

请求参数名

必填

类型

请求参数说明

babyIdList

true

List

所选妹子ID列表

token

true

string

用户登录成功返回的token

json={"babyIdList":

[106,107,108,109]}

返回结果说明

返回参数

参数类型

返回参数说明

单个对象数据

code

int

返回码

msg

string

返回信息

data

string

“”

返回码说明

返回码（reponse_code）

说明

200

请求成功

400

请求失败（请求失败，没有获取到妹子信息）

18、支付宝请客（下单）接口

接口说明

接口描述

请客下单

访问地址

/alipay/free/orderNotify.do

请求方式

GET/POST

请求格式

JSON

返回格式

JSON

开发人

詹亚磊

备注

请求参数说明

请求参数名

必填

类型

请求参数说明

userId

true

int

用户ID

userCid

true

string

用户CID

userName

true

string

用户昵称

userPhone

true

string

用户手机号

userAddress

true

string

用户地址

meetAddress

true

string

约会地址

meetTime

true

date

约会时间

payMoney

true

bigDecimal

总支付金额

payType

true

int

支付方式

tradeAccount

true

string

收款账户

orderNo

true

string

订单号

orderDetailList

true

List

每条子订单的详情

MkOrderDetail—---必填字段如下：

babyName--string—妹子昵称

babyPhoto—string--妹子头像

gradeImg--string—等级图片

babyPhone--string—妹子手机号

scale--string—妹子尺度字符串

payMoney—bigDecimal--该妹子支付金额

babyCid--string—妹子cid

返回结果说明

返回参数

参数类型

返回参数说明

List对象数据

code

int

返回码

msg

string

返回信息

data

OrderPrederResponse

Model模型

返回码说明

返回码（reponse_code）

说明

200

请求成功

400

请求失败（没有查询到人气榜单信息）

19、魅客钱包支付请客（下单）接口

接口说明

接口描述

请客下单

访问地址

/alipay/walletOrder.do

请求方式

GET/POST

请求格式

JSON

返回格式

JSON

开发人

詹亚磊

备注

请求参数说明

请求参数名

必填

类型

请求参数说明

userId

true

int

用户ID

userCid

true

string

用户CID

userName

true

string

用户昵称

userPhone

true

string

用户手机号

userAddress

t