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

1、完整word版用户端接口文档用户端接口文档-詹亚磊2017/01/05版本记录版本记录日期提交人备注V1.02017-01-05詹亚磊APP（魅客用户端）接口文档登录模块1、用户登录接口接口说明接口描述用户登录接口访问地址/user/free/login.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注用户第一次登录则进行注册，返回用户信息请求参数说明请求参数名必填类型请求参数说明cidtrueString个推ciduserAccounttruestring登录信息（手机号或微信账号）typetrueint登录类型（是手机号登录还是第三方微信登录1：phone登录

2、，2：wechat登录）nickNamefalsestring微信注册（或登录）时获取的微信昵称photofalsestring微信注册（或登录）时获取的微信头像返回结果说明返回参数参数类型返回参数说明单个对象数据codeint返回码msgstring返回信息dataMmUserModel模型返回码说明返回码（reponse_code）说明200请求成功400请求失败（登录信息有误！）2、用户免登录接口接口说明接口描述用户免登录接口访问地址/user/free/autoLogin.do请求方式GET/POST请求格式JSON返回格式JSON开发人陈天兰备注用户免登录请求参数说明请求参数名必填类

3、型请求参数说明userIdtrueint用户idtokentruestring用户token(token在json请求数据中传递)返回结果说明返回参数参数类型返回参数说明单个对象数据codeint返回码msgstring返回信息dataMmUserModel模型返回码说明返回码（reponse_code）说明200请求成功400请求失败（免登录信息有误！）3、用户退出接口接口说明接口描述用户退出接口访问地址/user/logout.do请求方式GET/POST请求格式JSON返回格式JSON开发人刘辉备注用户退出登录，清空token请求参数说明请求参数名必填类型请求参数说明userIdtrue

4、int当前用户IDtokentruestring用户携带的token返回结果说明返回参数参数类型返回参数说明单个对象数据codeint返回码msgstring返回信息dataint更新影响条数（row = 1退出成功，row1失败）返回码说明返回码（reponse_code）说明200请求成功400请求失败（退出登录有误！）首页模块4、首页根据等级展示接口接口说明接口描述首页等级排序接口访问地址/user/free/gradeList.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注（显示所有通过审核且在服务状态的妹子）等级降序请求参数说明请求参数名必填类型请求参数

5、说明pageNumbtrueint当前页码（从1开始，第几页）lattruestring用户当前维度lagtruestring用户当前经度返回结果说明返回参数参数类型返回参数说明Map对象数据codeint返回码msgstring返回信息babyListListModel模型bannerListListModel模型返回码说明返回码（reponse_code）说明200请求成功400请求失败（没有查询到妹子信息）5、首页根据距离展示接口接口说明接口描述首页距离排序接口访问地址/user/free/distanceList.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊

6、备注（显示所有通过审核且在服务状态的妹子）与用户距离降序请求参数说明请求参数名必填类型请求参数说明pageNumbtrueint当前页码（从1开始，第几页）lattruestring用户当前维度lagtruestring用户当前经度返回结果说明返回参数参数类型返回参数说明Map对象数据codeint返回码msgstring返回信息babyListListModel模型bannerListListModel模型返回码说明返回码（reponse_code）说明200请求成功400请求失败（没有查询到妹子信息）6、首页根据注册时间最新展示接口接口说明接口描述首页最新列表接口访问地址/user/fre

7、e/newList.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注（显示所有通过审核且在服务状态的妹子）审核时间降序请求参数说明请求参数名必填类型请求参数说明pageNumbtrueint当前页码（从1开始，第几页）lattruestring用户当前维度lagtruestring用户当前经度返回结果说明返回参数参数类型返回参数说明Map对象数据codeint返回码msgstring返回信息babyListListModel模型bannerListListModel模型返回码说明返回码（reponse_code）说明200请求成功400请求失败（没有查询到妹子信息）

8、7、首页默认展示接口接口说明接口描述默认主页显示（妹子信息）访问地址/user/free/gradeList.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数说明pageNumbtrueint当前页码（从1开始，第几页）lattruestring用户当前维度lagtruestring用户当前经度返回结果说明返回参数参数类型返回参数说明Map对象数据codeint返回码msgstring返回信息babyListListModel模型bannerListListModel模型返回码说明返回码（reponse_code）说明200请求

9、成功400请求失败（没有查询到妹子信息）8、首页-筛选查询接口接口说明接口描述首页筛选查询（根据年纪、身高、体重、金额条件查询）访问地址/user/free/filtrateBaby.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注（显示所有通过审核且在服务状态的妹子）按服务价格（等级）降序、和用户距离升序排列请求参数说明请求参数名必填类型请求参数说明pageNumbtrueint当前页码（从1开始）lattruestring用户当前维度lagtruestring用户当前经度maxAgetrueint年龄上限minAgetrueint年龄下限maxHeighttru

10、eint身高上限minHeighttrueint身高下限maxWeighttrueint体重上限minWeighttrueint体重下限maxGradePricetruedouble服务价格上限minGradePricetruedouble服务价格下限测试数据-请求参数：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返回结果说明返回参数参数类型返回参

11、数说明Map对象数据codeint返回码msgstring返回信息babyListListModel模型bannerListListModel模型返回码说明返回码（reponse_code）说明200请求成功400请求失败（没有查询到妹子信息）9、显示妹子详细信息接口接口说明接口描述显示妹子详细信息访问地址/user/free/babyDetail.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注显示妹子详细信息（包括评价分数及当前用户对妹子的关注状态）请求参数说明请求参数名必填类型请求参数说明userIdtrueint当前用户IdbabyIdtrueint所选妹子

12、Id返回结果说明返回参数参数类型返回参数说明Map对象数据codeint返回码msgstring返回信息babyMsBaby所有妹子信息（Model对象）rateAvgdouble妹子的评价平均分isAttentionint当前用户对该妹子的关注状态返回码说明返回码（reponse_code）说明200请求成功400请求失败（没有查询到妹子详细信息）10、关注妹子接口接口说明接口描述用户关注妹子（已关注则取消，未关注则加关注）访问地址/user/attention.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注已关注则取消关注，未关注则加关注请求参数说明请求参数名

13、必填类型请求参数说明userIdtrueint用户IDbabyIdtrueint所选妹子IDisAttentiontrueint用户对所选妹子的关注状态（是否关注，显示妹子详情时已返回前端）tokentruestring用户登录成功返回的token返回结果说明返回参数参数类型返回参数说明单个对象数据codeint返回码msgstring返回信息dataint用户对所选妹子的关注状态（isAttention）返回码说明返回码（reponse_code）说明200请求成功400请求失败（各种消息语）11、约会接口（点击约她）接口说明接口描述填写订单访问地址/user/invite.do请求方式GE

14、T/POST请求格式JSON返回格式JSON开发人詹亚磊备注填写订单页面需要显示的妹子信息请求参数说明请求参数名必填类型请求参数说明babyIdtrueint所选妹子IDtokentruestring用户登录成功返回的token返回结果说明返回参数参数类型返回参数说明单个对象数据codeint返回码msgstring返回信息dataMkOrderDetailModel模型返回码说明返回码（reponse_code）说明200请求成功400请求失败（请求失败，没有获取到妹子信息）排行榜模块12、人气排行榜接口接口说明接口描述显示妹子人气排行榜访问地址/user/free/popularList.

15、do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注按妹子已约单数降序排序请求参数说明请求参数名必填类型请求参数说明pageNumbtrueint当前页数（第几页，从1开始）返回结果说明返回参数参数类型返回参数说明List对象数据codeint返回码msgstring返回信息dataListModel模型返回码说明返回码（reponse_code）说明200请求成功400请求失败（没有查询到人气榜单信息）13、信誉排行榜接口接口说明接口描述信誉排行榜访问地址/user/free/creditList.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚

16、磊备注按妹子评价分降序排序请求参数说明请求参数名必填类型请求参数说明pageNumbTrueint当前页数（第几页，从1开始）返回结果说明返回参数参数类型返回参数说明List对象数据codeint返回码msgstring返回信息dataListModel模型返回码说明返回码（reponse_code）说明200请求成功400请求失败（没有查询到信誉榜信息）用户端订单模块14、获取支付宝相关的KEY配置接口接口说明接口描述返回阿里支付相关的key配置访问地址/alipay/keys.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数

17、说明tokentruestringtoken返回结果说明返回参数参数类型返回参数说明Map对象数据codeint返回码msgstring返回信息alipayPartnerstringalipayPrivateKeystring私钥alipayPublicKeystring公钥alipayOrderNotifyUrlstring回调地址alipayRechargeNotifyUrlstring返回码说明返回码（reponse_code）说明200请求成功400请求失败（请求失败，没有获取到妹子信息）15、妹子是否有订单状态检查接口接口说明接口描述当前所选妹子是否已被抢走访问地址/userOrde

18、r/haveOrder.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注妹子当前是否在订单状态请求参数说明请求参数名必填类型请求参数说明babyIdListtrueList所选所有妹子的IDtokentruestring用户登录成功返回的tokenjson=babyIdList:106,107,108,109返回结果说明返回参数参数类型返回参数说明Map对象数据codeint返回码msgstring返回信息haveOrderboolean是否有被抢单的妹子（true-有妹子已被抢走）cancleBabyListList被抢单的妹子的信息返回码说明返回码（repons

19、e_code）说明200请求成功400请求失败（请求失败，没有获取到妹子信息）16、支付检查接口（支付之前调用，更改妹子为有订单状态）接口说明接口描述支付之前调用，更改妹子为有订单状态访问地址/userOrder/payCheck.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注妹子当前是否在订单状态请求参数说明请求参数名必填类型请求参数说明babyIdListtrueList所选所有妹子的IDtokentruestring用户登录成功返回的tokenjson=babyIdList:106,107,108,109返回结果说明返回参数参数类型返回参数说明Map对象数据

20、codeint返回码msgstring返回信息cancleBabyListList如果所选妹子中有已被抢单的，则返回被抢单的妹子信息返回码说明返回码（reponse_code）说明200请求成功400请求失败17、用户支付失败，更新妹子订单状态接口接口说明接口描述用户支付失败，更新所选妹子的订单状态为无订单访问地址/userOrder/payFail.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数说明babyIdListtrueList所选妹子ID列表tokentruestring用户登录成功返回的tokenjson=baby

21、IdList:106,107,108,109返回结果说明返回参数参数类型返回参数说明单个对象数据codeint返回码msgstring返回信息datastring“”返回码说明返回码（reponse_code）说明200请求成功400请求失败（请求失败，没有获取到妹子信息）18、支付宝请客（下单）接口接口说明接口描述请客下单访问地址/alipay/free/orderNotify.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数说明userIdtrueint用户IDuserCidtruestring用户CIDuserNametr

22、uestring用户昵称userPhonetruestring用户手机号userAddresstruestring用户地址meetAddresstruestring约会地址meetTimetruedate约会时间payMoneytruebigDecimal总支付金额payTypetrueint支付方式tradeAccounttruestring收款账户orderNotruestring订单号orderDetailListtrueList每条子订单的详情MkOrderDetail-必填字段如下：babyName-string妹子昵称babyPhotostring-妹子头像gradeImg-str

23、ing等级图片babyPhone-string妹子手机号scale-string妹子尺度字符串payMoneybigDecimal-该妹子支付金额babyCid-string妹子cid返回结果说明返回参数参数类型返回参数说明List对象数据codeint返回码msgstring返回信息dataOrderPrederResponseModel模型返回码说明返回码（reponse_code）说明200请求成功400请求失败（没有查询到人气榜单信息）19、魅客钱包支付请客（下单）接口接口说明接口描述请客下单访问地址/alipay/walletOrder.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数说明userIdtrueint用户IDuserCidtruestring用户CIDuserNametruestring用户昵称userPhonetruestring用户手机号userAddresst