用户端接口文档.doc_咨信网zixin.com.cn

资源描述

用户端接口文档-詹亚磊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<UserHomeResponse> Model模型 bannerList List<SysBanner> 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<UserHomeResponse> Model模型 bannerList List<SysBanner> 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<UserHomeResponse> Model模型 bannerList List<SysBanner> 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<UserHomeResponse> Model模型 bannerList List<SysBanner> 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<UserHomeResponse> Model模型 bannerList List<SysBanner> 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<UserHomeResponse> 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<UserHomeResponse > 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<Integer> 所选所有妹子的ID token true string 用户登录成功返回的token json={"babyIdList":[106,107,108,109]} 返回结果说明返回参数参数类型返回参数说明 Map对象数据 code int 返回码 msg string 返回信息 haveOrder boolean 是否有被抢单的妹子（true-有妹子已被抢走） cancleBabyList List<BabyHaveOrderResponse> 被抢单的妹子的信息返回码说明返回码（reponse_code）说明 200 请求成功 400 请求失败（请求失败，没有获取到妹子信息） 16、支付检查接口（支付之前调用，更改妹子为有订单状态）接口说明接口描述支付之前调用，更改妹子为有订单状态访问地址 /userOrder/payCheck.do 请求方式 GET/POST 请求格式 JSON 返回格式 JSON 开发人詹亚磊备注妹子当前是否在订单状态请求参数说明请求参数名必填类型请求参数说明 babyIdList true List<Integer> 所选所有妹子的ID token true string 用户登录成功返回的token json={"babyIdList":[106,107,108,109]} 返回结果说明返回参数参数类型返回参数说明 Map对象数据 code int 返回码 msg string 返回信息 cancleBabyList List<BabyHaveOrderResponse> 如果所选妹子中有已被抢单的，则返回被抢单的妹子信息返回码说明返回码（reponse_code）说明 200 请求成功 400 请求失败 17、用户支付失败，更新妹子订单状态接口接口说明接口描述用户支付失败，更新所选妹子的订单状态为无订单访问地址 /userOrder/payFail.do 请求方式 GET/POST 请求格式 JSON 返回格式 JSON 开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数说明 babyIdList true List<Integer> 所选妹子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> 每条子订单的详情 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 true string 用户地址 meetAddress true string 约会地址 meetTime true date 约会时间 payMoney true bigDecimal 总支付金额 payType true int 支付方式 tradeAccount true string 收款账户 orderNo true string 订单号 orderDetailList true List<MkOrderDetail> 每条子订单的详情 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 请求失败（没有查询到人气榜单信息） 20、分享-请客发送H5页面接口接口说明接口描述用户支付失败，更新所选妹子的订单状态为无订单访问地址 /userOrder/payFail.do 请求方式 GET/POST 请求格式 JSON 返回格式 JSON 开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数说明 babyId true int 所选妹子ID token true string 用户登录成功返回的token 返回结果说明返回参数参数类型返回参数说明单个对象数据 code int 返回码 msg string 返回信息 data boolean true-当前妹子已被抢走，有订单 false-当前妹子不在订单状态返回码说明返回码（reponse_code）说明 200 请求成功 400 请求失败（请求失败，没有获取到妹子信息） 21、H5约会接口接口说明接口描述 H5选妹子访问地址 /userOrder/free/htmlInvite.do 请求方式 GET/POST 请求格式 JSON 返回格式 JSON 开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数说明 babyId true int 所选妹子ID userCid true string 邀请人的Cid 返回结果说明返回参数参数类型返回参数说明单个对象数据 code int 返回码 msg string 返回信息 data MkOrderDetail Model模型返回码说明返回码（reponse_code）说明 200 请求成功 400 请求失败（请求失败，没有获取到妹子信息） 22、评价接口接口说明接口描述请客下单访问地址 /userOrder/rate.do 请求方式 GET/POST 请求格式 JSON 返回格式 JSON 开发人陈明钦备注 json={"rateDetailList":[{"orderId":"900","userId":"1","userName":"username","userPhoto":"1.jpg","content":"content","score":"10","babyName":babyName","babyId":"62","babyPhoto":"babyPhoto.jpg","babyPhone":"110","scale":"可爱"}]} 请求参数说明请求参数名必填类型请求参数说明 orderId true int 订单ID userId true string 用户ID userName true string 用户昵称 userPhoto true string 用户头像 content false string 评价内容 score true double 评价分数 babyName true date 宝贝名称 babyId true bigDecimal 宝贝ID babyPhoto true int 宝贝头像 babyPhone true string 宝贝手机 scale false String 宝贝尺度字符窜数组返回结果说明返回参数参数类型返回参数说明单个对象数据 code int 返回码 msg string 返回信息 data row int类型返回码说明返回码（reponse_code）说明 200 请求成功 400 请求失败（评价失败） 23、约会-用户当前订单详情接口接口说明接口描述用户当前订单详情访问地址 /userOrder/currentOrderDetail.do 请求方式 GET/POST 请求格式 JSON 返回格式 JSON 开发人詹亚磊备注显示用户正在进行中的订单详情请求参数说明请求参数名必填类型请求参数说明 userId true int 当前用户ID token true string 用户登录成功返回的token 返回结果说明返回参数参数类型返回参数说明 Map对象数据 code int 返回码 msg string 返回信息 currentOrder CurrentOrderResponse Model模型 haveOrder int 用户当前是否有订单返回码说明返回码（reponse_code）说明 200 请求成功 400 请求失败（没有查询到订单信息）妹子端订单模块 24、约会-妹子当前订单详情接口接口说明接口描述妹子当前订单详情访问地址 /babyOrder/currentOrderDetail.do 请求方式 GET/POST 请求格式 JSON 返回格式 JSON 开发人詹亚磊备注显示妹子当前订单详情和评价信息请求参数说明请求参数名必填类型请求参数说明 babyId true int 当前妹子ID orderId true int 当前大订单ID orderDetailId true int 当前订单详情Id（小订单） token true string 用户登录成功返回的token 返回结果说明返回参数参数类型返回参数说明 Map对象数据 code int 返回码 msg string 返回信息 currentOrder MkOrder Model模型(订单详情) userOrderRate MkOrderRate Model模型（评价详情）返回码说明返回码（reponse_code）说明 200 请求成功 400 请求失败（没有查询到订单信息） 25、妹子已到达接口接口说明接口描述妹子已到达约会地点，给用户推送消息访问地址 /babyOrder/reached.do 请求方式 GET/POST 请求格式 JSON 返回格式 JSON 开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数说明 orderId true int 当前大订单ID orderDetailId true int 当前订单详情ID（小订单） userId true int 用户ID late true int 妹子迟到的分钟数 payMoney true bigDecimal 支付金钱 userCid true string 用户cid token true string 用户登录成功返回的token 返回结果说明返回参数参数类型返回参数说明 Map对象数据 code int 返回码 msg string 返回信息 orderStatus int 当前订单状态 fineMoney bigDecimal 罚金钱返回码说明返回码（reponse_code）说明 200 请求成功 400 请求失败（请求失败，没有获取到妹子信息） 26、妹子已完成接口接口说明接口描述妹子点击完成订单访问地址 /babyOrder/finish.do 请求方式 GET/POST 请求格式 JSON 返回格式 JSON 开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数说明 orderId true int 当前大订单ID orderDetailId true int 当前订单详情ID（小订单） userId true int 用户ID babyId true int 妹子ID payMoney true bigDecimal 支付金钱 fineMoney true bigDecimal 罚金钱 userCid true string 用户cid token true string 用户登录成功返回的token 返回结果说明返回参数参数类型返回参数说明单个对象数据 code int 返回码 msg string 返回信息 data int 订单状态返回码说明返回码（reponse_code）说明 200 请求成功 400 请求失败（请求失败，没有获取到妹子信息） “我的”模块 27、我的主页接口接口说明接口描述我的主页显示数据（历史订单数和我关注的人数）访问地址 /user/myHomePage.do 请求方式 GET/POST 请求格式 JSON 返回格式 JSON 开发人詹亚磊备注显示历史订单数和我关注的人数（用户头像和昵称在登录时已返回）请求参数说明请求参数名必填类型请求参数说明 userId true int 用户ID token true string 用户登录成功返回的token 返回结果说明返回参数参数类型返回参数说明 Map对象数据 code int 返回码 msg string 返回信息 orderCounter int 历史订单数 attentionCounter int 我的关注人数 money bigDecimal 最新的钱包数据返回码说明返回码（reponse_code）说明 200 请求成功 400 请求失败（没有查询到订单数和关注数信息） 28、支付宝钱包充值接口接口说明接口描述钱包充值访问地址 /alipay/free/rechargeNotify.do 请求方式 GET/POST 请求格式 JSON 返回格式 JSON 开发人詹亚磊备注显示历史订单数和我关注的人数（用户头像和昵称在登录时已返回）请求参数说明请求参数名必填类型请求参数说明 userId

展开阅读全文