[[TOC]] = 摩登学院1.0.0接口文档 = >mrobot代理环境说明: 192.168.10.198:1080(192.168.74.80)[[BR]] 192.168.10.199 端口为 1080 连的是dev40的开发环境(192.168.75.40)[[BR]] ps1:未到qa阶段,连开发环境调试(若仅做代理,mrobot不存在真正的处理文件,只作转发的功能) [[BR]] ps2:common_session_id都是在cookies中添加此参数,测试环境为common_session_id1 [[BR]] [http://trac.pc.com.cn/mobile/pototype/pclady/modernkt/V1.0/ "框架"][[BR]] [http://192.168.50.235/yidongUI/2016-04/modeng-app/index.html "设计稿地址"][[BR]] [http://rdtrac.pc.com.cn/iphone/wiki/pclady_modern1.0.0%E7%BB%88%E7%AB%AF%E5%8D%8F%E8%AE%AE "终端协议"][[BR]] [http://192.168.10.131:8080/org/group.do?plid=14 "接口RAP地址"] [[BR]] [http://zzb.pcauto.com.cn/tools/gongdan/plan.php?id=251 "制作稿地址"] == 1.公用接口 == ---------- === 1.1新增用户 === 开发环境:http://dev15.pclady.com.cn:85/app/common/addUser.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/common/addUser.do [[BR]] **说明** >初次登录后,通知平台添加用户 **缓存时间** >0 **提交方式** >POST **是否登录** >是 **数据来源** > passport **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||type||类型||String||""||否||1:qq,2:微信,3:新浪|| ||nickName||昵称||String||""||否|||| **返回** {{{#!java { "status":0, "msg":"请求成功", "sig":"sig" } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =|| ||= status =||= 0:成功,-1:失败原因=|| ||= sig =||= 腾讯生成的sig=|| === 2.2启动上报 === 开发环境:http://dev15.pclady.com.cn:85/app/common/reportStartUp.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/common/reportStartUp.do [[BR]] **说明** > 当天用户第一次启动时,需要上报一次。便于判断活跃度,以后发送通知时会用到 **缓存时间** >0 **提交方式** > POST **是否登录** > 是 **数据来源** >魔方token **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||==|| ||= type =||= 客户端类型 =||= int =||= "" =||= 否 =||= 1:IOS,2:Android =|| ||= token =||= 魔方推送apns token =||= String =||= "" =||= 否 =||= IOS为魔方的token,安卓为deviceid =|| **返回** {{{#!java { "status":0, "msg":"请求成功" } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| ---------- == 2.首页 == === 2.1首页 === 开发环境:http://dev15.pclady.com.cn:85/app/common/index.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/common/index.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x-300/modern.pclady.com.cn/app/common/index.do **说明** > 根据需求文档返回对应的节点[[BR]] > 由于需要查询正在直播的视频,先不考虑缓存[[BR]] > pageNo=1时需要返回所有节点,pageNo>1时,只需要返回data节点[[BR]] **缓存时间** >0 **提交方式** > GET **是否登录** > 否 **数据来源** >摩登后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||=说明=|| ||pageNo||页数,morbot用到,后端接口不需要||int||1||是|||| ||pageSize||页面大小||int||10||是|||| ||= deviceId =||=设备ID=||=String=||= "" =||= 是 =||按手机判断每个用户每天首次请求时,返回hotImage节点|| **返回** {{{#!java { "status": 0, "msg": "请求成功", "total":100, "focus": [ { "typeName": "焦点图类型", "imageUrl": "http://img.pconline.com.cn/7.jpg", "url": "外链url", "contentId": "14324" "title":"标题" } ], "tagList":[ { "tagId":111, "tagName":标签名, "tagImageUrl":"标签图片地址", } ], "enter":[ { "typeName":"APP内页地址", "imageUrl":"http://img.pconline.com.cn/7.jpg", "url":"外链url" "title":"功能名", "subTitle":"子标题", "contentId": "14324" } ], "hotImage":{//启动推送图片 "typeName":"APP内页地址", "imageUrl":"http://img.pconline.com.cn/7.jpg", "url":"外链url", "contentId": "14324", "title":"标题" }, "todayLiveVideo": [ { "courseId": 11, "liveType": 1,//1:直播,2:预告,3:视频教程,4:回顾视频 "imageUrl": "http://img.pconline.com.cn/7.jpg", "techId": 1111, "followTotal":2,//关注人数 "techJobName": "××御用化妆师", "techNickName": "老师姓名", "techHeadUrl":"老师头像地址", "techIconUrl": "http://img.pconline.com.cn/7.jpg", "title": "课程标题", "subTitle":"小标题", "desc":"课程描述" "startTime": "MM.dd hh:mm", "watchTotal": 100 "timerTotal":倒计时//单位秒, ], "teacher":{ [ { "techId": 111, "techJobName": "××御用化妆师", "techNickName": "老师姓名", "techIconUrl": "http://img.pconline.com.cn/7.jpg", "techHeadUrl":"老师头像地址", "followTotal":100//粉丝数 } ] }, "chosenVideo": [ { "courseId": 11, "liveTime": "6'33''", "liveType": 1,//1:直播,2:预告,3:视频教程,4:回顾视频 "imageUrl": "http://img.pconline.com.cn/7.jpg", "techId": 1111, "techJobName": "××御用化妆师", "techNickName": "老师姓名", "techIconUrl": "http://img.pconline.com.cn/7.jpg", "title": "课程标题", "watchTotal": 100, "tag": [ { "tagId": 11, "tagName": "标签" } ] } ], "extensions": [//推广位 { "typeName": "APP页面类型", "imageUrl": "http://img.pconline.com.cn/7.jpg", "url": "外链url", "contentId": "14324", "title":"推广位标题" } ], "data": [ { "courseId": 11, "liveType": 1,//1:直播,2:预告,3:视频教程,4:回顾视频 "liveTime": "6'33''", "imageUrl": "http://img.pconline.com.cn/7.jpg", "techId": 1111, "techJobName": "××御用化妆师", "techNickName": "老师姓名", "techIconUrl": "http://img.pconline.com.cn/7.jpg", "title": "课程标题", "watchTotal": 100, } ] } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| ||= typeName =||= 直播课列表 liveList;课程标签列表 tagList;直播课终端页 liveCourseInfo;视频课程终端页 videoCourseInfo;发现页 findList;老师列表 techerList;老师主页 techInfo;外链 webView =||= focus =||= 焦点图节点,返回5张焦点图 =|| ||= liveType =||= //1:直播,2:预告,3:视频教程,4:回顾视频 =||=imageUrl =||= liveVideo节点中为封面图 =|| ||= techID =||= 老师ID =||=techJobName =||= 头衔 =|| ||= startTime =||= 如果为预告,要返回开始时间 =||=watchTotal =||= 如果是直播,返回观看人数 =|| ||= techIconUrl =||= 老师等级icon =||= =||= =|| ||= teacher =||= 老师推荐节点,7条 =||=chosenVideo =||= 精选直播课节点,6条 =|| ||= liveTime =||= 视频时长 =||=tag =||= 标签,最多三个 =|| ||= hotVideo =||= 热点视频节点 =||=tag =||= 标签,最多三个 =|| ||= subTitle =||= 小标题 =||=hotTeacher =||= 人气老师 =|| ||= extensions =||= 推广位,最多两条,没有就不返回该结点 =||=techIconUrl=||= 老师等级icon =|| [[BR]] ---------- == 3.公开课 == === 3.1获取课程列表 === 开发环境:http://dev15.pclady.com.cn:85/app/course/courseList.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/course/courseList.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/course/courseList.do **说明** >获取公开课列表,默认加载10条[[BR]] >显示顺序:正在直播和预告优先显示。其余按回顾直播课的开始时间、视频教程的启用时间,新到旧排列[[BR]] > 由于需要查询正在直播的视频,先不考虑缓存[[BR]] **缓存时间** >0分钟 **提交方式** >GET **是否登录** > 否 **数据来源** > 后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||pageNo||页数||int||1||是|| ||pageSize||页面大小||int||10||是|| **返回** {{{#!java { "status": 0, "msg": "请求成功", "pageNo": 1, "pageSize": 20, "total": 100, "todayLive":{ "courseId": 11, "liveType": 1,//1:直播,2:预告,3:视频教程,4:回顾视频 "imageUrl": "http://img.pconline.com.cn/7.jpg", "techId": 1111, "techJobName": "××御用化妆师", "techNickName": "老师姓名", "techIconUrl": "http://img.pconline.com.cn/7.jpg", "techHeadUrl":"老师头像地址", "title": "课程标题", "desc":"课程描述" "watchTotal": 100 }, "todayYG"[{ "courseId": 11, "liveType": 1,//1:直播,2:预告,3:视频教程,4:回顾视频 "imageUrl": "http://img.pconline.com.cn/7.jpg", "techId": 1111, "techJobName": "××御用化妆师", "techNickName": "老师姓名", "techIconUrl": "http://img.pconline.com.cn/7.jpg", "techHeadUrl":"老师头像地址", "title": "课程标题", "startTime": "MM.dd hh:mm", "timerTotal":倒计时//单位秒, }] "data": [ { "courseId": 11, "liveType": 1,//1:直播,2:预告,3:视频教程,4:回顾视频 "liveTime": "6'33''", "startTime": "MM.dd hh:mm", "imageUrl": "http://img.pconline.com.cn/7.jpg", "techId": 1111, "techJobName": "××御用化妆师", "techNickName": "老师姓名", "techIconUrl": "http://img.pconline.com.cn/7.jpg", "techHeadUrl":"老师头像地址", "title": "课程标题", "watchTotal": 100, "tag": [ { "tagId": 11, "tagName": "标签" } ] } ] } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| ||= liveType =||= //1:直播,2:预告,3:视频教程,4:回顾视频 =||= liveTime =||= 视频时长 =|| ||= imageUrl =||= 封面图 =||=watchTotal =||= 如果是直播,返回观看人数 =|| ||= techID =||= 老师ID =||=techJobName =||= 头衔 =|| ||= startTime =||= 如果为预告,要返回开始时间 =||=tag =||= 标签,最多三个 =|| ||= techIconUrl =||= 老师等级icon =||= =||= =|| ||= todayLive =||= 正在直播的视频节点,没有时不返回 =||=todayYG =||= 今日预告节点,没有时不返回 =|| [[BR]] === 3.2直播课终端页(wap) === 开发环境:http://dev15.pclady.com.cn:85/app/course/liveCourseInfo.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/course/liveCourseInfo.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/course/liveCourseInfo.do **说明** >直播课和预告终端页[[BR]] **缓存时间** >0分钟 **是否登录** > 是 **提交方式** >GET **数据来源** > 后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||courseId||课程ID||String||""||是|| ||= inReview= ||=1:审核状态 0:发布状态,mrobot用到=||=int=||= 0 =||= 否 =|| ||= deviceId =||=设备ID=||=String=||= "" =||= 是 =|| **返回** {{{#!java { "status": 0, "msg": "请求成功", "data": { "state":1,// 1 未开始 2 直播中 3下载中 4可回放 "courseId": 11, "imageUrl": "http://img.pconline.com.cn/7.jpg", "liveType": 1,//1:直播,2:预告,3:视频教程,4:回顾视频 "isLive":1,//0表示假直播,1表示真直播 "title": "课程标题", "courseUrl": ["http://view.mp4","视频地址"], "timeCount": 120, "startTime": "YYYY-MM-dd hh:mm", "shareUrl": "http://wap.pclady.com.cn/111.html", "isSignUp": 1, "isCollect": 1, "oldPrice": 100, "price": 50, "signUpTotal": 100, "techId": 1111, "techJobName": "××御用化妆师", "techNickName": "老师姓名", "techIconUrl": "http://img.pconline.com.cn/7.jpg", "techDesc": "老师描述", "techHeadUrl":"老师头像地址", "passportID":111,//老师passportID,直播的时候,根据老师ID来渲染 "isFollow": 1, "isSupport": 1, "followTotal":100, "supportTotal":100, "tag": [ { "tagId": 11, "tagName": "标签" } ], "courseDesc": "课程描述", "outline":"课程大纲",//新加,edit by wxl "notice":"上课需知", "courseList": [ { "courseId": 11, "liveType": 1,//1:直播,2:预告,3:视频教程,4:回顾视频 "liveTime": "6'33''", "startTime": "MM.dd hh:mm", "imageUrl": "http://img.pconline.com.cn/7.jpg", "title": "课程标题" } ], "followUserIdList": [//报名用户的ID,最多8条 "111", "222" ] } } mrobot返回的html中的json /*@_HTML_META_START_ { data节点的数据 } _HTML_META_END_@*/ }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| ||= startTime =||= 开始时间,预告需要返回 =||=timeCount =||= 倒计时,单位为秒 =|| ||= shareUrl =||= 分享的wap地址 =||=isSignUp =||= 是否报名,1:是,0:否 =|| ||= title =||= 课程标题 =||=isCollect =||= 是否收藏,1:是,0:否 =|| ||= type =||= 上课方式,1:直播课 =||=price =||= 价格 =|| ||= oldPrice =||= 原价 =||=signUpTotal =||= 报名人数 =|| ||= techID =||= 老师ID =||=techJobName =||= 头衔 =|| ||= techIconUrl =||= 老师等级icon =||= =||= =|| ||= isFollow =||= 是否关注老师,1:是,0:否 =||=tag =||= 标签,最多三个 =|| ||= isSupport =||= 是否点赞,1:是,0:否 =||=courseList =||= 相关课程,两条 =|| ||= followTotal =||= 关注人数=||=supportTotal =||= 点赞人数 =|| [[BR]] === 3.3直播课终端页问答列表(wap) === 开发环境:http://dev15.pclady.com.cn:85/app/course/requestList.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/course/requestList.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/course/requestList.do **说明** >问答列表[[BR]] **缓存时间** >0分钟 **是否登录** > 是 **提交方式** >GET **数据来源** > 后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||courseId||课程ID||String||""||是|| ||pageNo||页数||int||1||是|| ||pageSize||页面大小||int||10||是|| **返回** {{{#!java { "status": 0, "msg": "请求成功", "adminMessage":"管理员消息"//pageNo=1的时候才返回 "total":"评论总数",//新加,edit by wxl "data": [ { "requestId": 11, "userId": 111, "nickName": "昵称", "message": "问题内容", "techIconUrl": "老师等级图标url", "imageUrl": ["http://img.pconline.com.cn/7.jpg","http://img.pconline.com.cn/7.jpg"], "createTime": "MM-dd hh:mm", "techType":1//1:老师,如果是老师,有这参数 "techHeadUrl":"老师头像地址", } ] } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| [[BR]] === 3.4发表问题 === 开发环境:http://dev15.pclady.com.cn:85/app/course/sendRequest.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/course/sendRequest.do [[BR]] **说明** > 发表问题 **缓存时间** >0分钟 **提交方式** > POST **是否登录** > 是 **数据来源** >整形库编辑后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 说明 =|| ||= courseId =||=课程ID =||= string =||= "" =||= 是 =||= =|| ||= message =||=内容=||= string =||= "" =||= 是 =||=回复内容 =|| ||= imageURL =||=图片地址,多个时用英文逗号隔开,最多三张=||= string =||= "" =||= 否 =||=回复时不需要传 =|| **返回** {{{#!java { "status":0, "msg":"请求成功" } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| === 3.5收藏/取消收藏 === 开发环境:http://dev15.pclady.com.cn:85/app/course/collection.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/course/collection.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/course/collection.do **说明** > 收藏/取消收藏 **缓存时间** >0分钟 **提交方式** > POST **是否登录** > 是 **数据来源** > **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||courseId||ID,批量取消收藏时,用英文逗号隔开,type为1或2时必填|| String ||""||否|| ||courseGoodsId||ID,批量取消收藏时,用英文逗号隔开,type为3时必填|| String ||""||否|| ||type||类型:1:视频,2:直播,3,商品|| int ||""||是|| ||operation||操作:1:收藏,2:取消收藏|| int ||""||是|| **返回** {{{#!java { "status":0, "msg":"请求成功" "state":1 } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| ||= state =||= 1:收藏,0:未收藏,返回状态是为了防止网络不太稳定的时候,连续点击,客户端状态更新错误,批量操作不需要返回 =||==||==|| === 3.6关注/取消关注老师 === 开发环境:http://dev15.pclady.com.cn:85/app/teacher/followTech.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/teacher/followTech.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/teacher/followTech.do **说明** > 关注/取消关注老师 **缓存时间** >0分钟 **提交方式** > POST **是否登录** > 是 **数据来源** > **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||techId||ID,批量取消关注时,用英文逗号隔开|| String ||""||是|| ||operation||操作:1:关注,2:取消关注|| int ||""||是|| **返回** {{{#!java { "status":0, "msg":"请求成功" "state":1 } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| ||= state =||= 1:关注,0:未关注,返回状态是为了防止网络不太稳定的时候,连续点击,客户端状态更新错误 =||==||==|| === 3.7点赞 === 开发环境:http://dev15.pclady.com.cn:85/app/course/support.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/course/support.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/course/support.do **说明** > 点赞 **缓存时间** >0分钟 **提交方式** > POST **是否登录** > 直播课报名之后才可以点赞;普通视频不需要登录也可以点赞。 **数据来源** > **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||courseId||ID|| String ||""||是|| ||deviceId||设备ID|| String ||""||是|| **返回** {{{#!java { "status":0, "msg":"请求成功", "supportTotal":100 } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| ||= supportTotal =||= 点赞成功后要返回点赞总数 =||=参数名=||=参数含意=|| === 3.8课后答疑(wap) === 开发环境:http://dev15.pclady.com.cn:85/app/course/answerList.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/course/answerList.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/course/answerList.do **说明** >课后答疑列表[[BR]] **缓存时间** >0分钟 **是否登录** > 否 **提交方式** >GET **数据来源** > 后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||courseId||课程ID||String||""||是|| ||pageNo||页数||int||1||是|| ||pageSize||页面大小||int||10||是|| **返回** {{{#!java { "status": 0, "msg": "请求成功", "pageNo": 1, "pageSize": 10, "total":30, "info": { "courseId": 11, "title": "课程标题", "imageUrl": "封面图", "startTime": "YYYY-MM-dd hh:mm", "shareUrl": "http://wap.pclady.com.cn/111.html", "techId": 1111, "techJobName": "××御用化妆师", "techNickName": "老师姓名", "techHeadUrl":"老师头像地址", "techIconUrl": "http://img.pconline.com.cn/7.jpg", "courseDesc": "课程描述", "publicNumber": "公众号" }, "data": [ { "answerId": 11, "type": 1, "message": "答疑内容", "customerHead": "小助手头像", "userHead": "用户头像", "imageUrl": "图片", "voiceUrl": "语音地址", } ] } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| ||= type =||= 1:问答小助手,2:用户 =||= publicNumber =||= 公众号 =|| [[BR]] === 3.9根据标签获取公开课列表 === 开发环境:http://dev15.pclady.com.cn:85/app/course/courseListWithTag.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/course/courseListWithTag.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/course/courseListWithTag.do **说明** >获取公开课列表,默认加载10条[[BR]] >显示顺序:正在直播和预告优先显示。其余按回顾直播课的开始时间、视频教程的启用时间,新到旧排列[[BR]] > 由于需要查询正在直播的视频,先不考虑缓存[[BR]] **缓存时间** >0分钟 **提交方式** >GET **是否登录** > 否 **数据来源** > 后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||pageNo||页数||int||1||是|| ||pageSize||页面大小||int||10||是|| ||tagId||标签Id||int||10||是|| **返回** {{{#!java { "status": 0, "msg": "请求成功", "pageNo": 1, "pageSize": 20, "total": 100, "data": [ { "courseId": 11, "liveType": 1,//1:直播,2:预告,3:视频教程,4:回顾视频 "liveTime": "6'33''", "startTime": "MM.dd hh:mm", "imageUrl": "http://img.pconline.com.cn/7.jpg", "techId": 1111, "techJobName": "××御用化妆师", "techNickName": "老师姓名", "techHeadUrl":"老师头像地址", "techIconUrl": "http://img.pconline.com.cn/7.jpg", "title": "课程标题", "watchTotal": 100, "tag": [ { "tagId": 11, "tagName": "标签" } ] } ] } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| ||= liveType =||= //1:直播,2:预告,3:视频教程,4:回顾视频 =||= liveTime =||= 视频时长 =|| ||= imageUrl =||= 封面图 =||=watchTotal =||= 如果是直播,返回观看人数 =|| ||= techID =||= 老师ID =||=techJobName =||= 头衔 =|| ||= startTime =||= 如果为预告,要返回开始时间 =||=tag =||= 标签,最多三个 =|| ||= techIconUrl =||= 老师等级icon =||=techType =||= 老师类型,1:老师,2:达人 =|| [[BR]] === 3.10报名=== 开发环境:http://dev15.pclady.com.cn:85/app/course/createOrder.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/course/createOrder.do [[BR]] **说明** >报名 **缓存时间** >0 **提交方式** >POST **是否需要登录** >是 **数据来源** > 整形库编辑后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||courseId||课程id||String||""||是|| ||r||时间截||String||""||是|| ||sign||MD5加密串||String||""||是|| **返回** {{{#!java { "status": 0, "msg": "请求成功", "state":1,// 1 未开始 2 直播中 3下载中 4可回放 "courseUrl": ["http://view.mp4","视频地址"]//加此参数的目地是:后台要去腾讯下载视频,打开终端页时可能还没下载完。点报名的时候如果下载完了,state为4的时候就需要返回播放地址。 } }}} === 3.11商品(wap) === 开发环境:http://dev15.pclady.com.cn:85/app/course/commodityList.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/course/commodityList.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/course/commodityList.do **说明** **缓存时间** >0分钟 **提交方式** >GET **是否登录** > 否 **数据来源** > 后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||pageNo||页数||int||1||是|| ||pageSize||页面大小||int||10||是|| ||courseId||课程ID||int||10||是|| **返回** {{{#!java { "status": 0, "msg": "请求成功", "pageNo": 1, "pageSize": 20, "total": 100, "data": [ { "commodityId":111, "imageUrl":"商品图片地址", "title":"标题", "spec":"规格", "price":"价格", "state":0,//0:我想要,1:已关注 } ] } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| [[BR]] === 3.12发现列表 === 开发环境:http://dev15.pclady.com.cn:85/app/course/findList.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/course/findList.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/course/findList.do **说明** >发现列表,获取热点标签和气老师[[BR]] **缓存时间** >15分钟 **提交方式** >GET **是否登录** > 否 **数据来源** > 后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||pageNo||页数||int||1||是|| ||pageSize||页面大小||int||10||是|| **返回** {{{#!java { "status": 0, "msg": "请求成功", "pageNo": 1, "pageSize": 20, "total": 100 "tagList": [{//pageNo=1时返回 "tagId":111, "tagName":"标签名" "tagImageUrl":"http://img.pconline.com.cn/7.jpg" }], "hotTeacther": [//pageNo=1时返回 { "techId": 111, "techJobName": "××御用化妆师", "techNickName": "老师姓名", "techHeadUrl":"老师头像地址", "techIconUrl": "http://img.pconline.com.cn/7.jpg", "courseTotal":100, "followTotal":2,//关注人数 } ], "data":[{ "tagId":111, "tagName":"标签名" "tagImageUrl":"http://img.pconline.com.cn/7.jpg" }] } }}} **返回参数说明** ||= tagList =||= 热点标签 =||=hotTeacther =||= 人气老师 =|| ||= =||= =||=tagImageUrl =||= 标签图片地址 =|| [[BR]] === 3.13视频课终端页(wap) === 开发环境:http://dev15.pclady.com.cn:85/app/course/videoCourseInfo.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/course/videoCourseInfo.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/course/videoCourseInfo.do[[BR]] 制作地址:http://zzsvn.pcauto.com.cn/svn/pclady/mobile/2016/mdxy_app/index.html [[BR]] **说明** >视频课终端页[[BR]] **缓存时间** >0分钟 **是否登录** > 是 **提交方式** >GET **数据来源** > 后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||courseId||课程ID||String||""||是|| ||= inReview= ||=1:审核状态 0:发布状态,mrobot用到=||=int=||= 0 =||= 否 =|| ||= deviceId =||=设备ID=||=String=||= "" =||= 是 =|| **返回** {{{#!java { "status": 0, "msg": "请求成功", "data": { "courseId": 11, "title": "课程标题", "imageUrl": "http://img.pconline.com.cn/7.jpg", "courseUrl": "http://view.mp4", "shareUrl": "http://wap.pclady.com.cn/111.html", "isSignUp": 1, "isCollect": 1, "techId": 1111, "techJobName": "××御用化妆师", "techNickName": "老师姓名", "techHeadUrl":"老师头像地址", "techIconUrl": "http://img.pconline.com.cn/7.jpg", "isFollow": 1, "isSupport": 1, "followTotal":100, "supportTotal":100, "courseDesc": "课程描述", "outline":"课程大纲",//新加 "notice":"上课需知"//新加 "enableTime":"启用时间"//新加,格式yyyy-MM-dd "tag": [ { "tagId": 11, "tagName": "标签" } ], "courseList": [ { "courseId": 11, "liveType": 1,//1:直播,2:预告,3:视频教程,4:回顾视频 "liveTime": "6'33''", "startTime": "MM.dd hh:mm", "imageUrl": "http://img.pconline.com.cn/7.jpg", "title": "课程标题" } ], } } mrobot返回的html中的json /*@_HTML_META_START_ { data节点的数据 } _HTML_META_END_@*/ }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| ||= liveType =||= //1:直播,2:预告,3:视频教程,4:回顾视频 =||= courseUrl =||= 视频地址 =|| ||= startTime =||= 开始时间,预告需要返回 =||=timeCount =||= 倒计时,单位为秒, =|| ||= shareUrl =||= 分享的wap地址 =||==||= =|| ||= title =||= 课程标题 =||=isCollect =||= 是否收藏,1:是,0:否 =|| ||= oldPrice =||= 原价 =||=signUpTotal =||= 报名人数 =|| ||= techID =||= 老师ID =||=techJobName =||= 头衔 =|| ||= techIconUrl =||= 老师等级icon =||= =||= =|| ||= isFollow =||= 是否关注老师,1:是,0:否 =||=tag =||= 标签,最多三个 =|| ||= isSupport =||= 是否点赞,1:是,0:否 =||=courseList =||= 相关课程,两条 =|| [[BR]] ---------- == 4.老师/达人 == === 4.1获取老师表 === 开发环境:http://dev15.pclady.com.cn:85/app/teacher/teacherList.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/teacher/teacherList.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/teacher/teacherList.do **说明** >获取老师列表,按老师主页浏览量、老师课程(公开课、视频课、私课)数量综合评估,从高到低排列 **缓存时间** >15分钟 **提交方式** >GET **是否登录** > 否//如果要看自己是关注的,需要登录 **数据来源** > 后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||pageNo||页数||int||1||是|| ||pageSize||页面大小||int||10||是|| ||techLevelId||老师等级ID,0表示全部||int||0||否|| **返回** {{{#!java { "status": 0, "msg": "请求成功", "pageNo": 1, "pageSize": 20, "total": 100, "level":[//老师等级,techLevelId=0且pageNo=1的时候返回该节点 { "techLevelId":1, "title":"老师" } ] "data": [ { "techId": 1111, "techJobName": "××御用化妆师", "techNickName": "老师姓名", "techIconUrl": "http://img.pconline.com.cn/7.jpg", "techDesc": "老师描述", "techHeadUrl":"老师头像地址", "followTotal":2,//关注人数, "courseTotal":100,// 课程数 "isFollow":1,//0:未关注,1:已关注 } ] } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| ||= techID =||= 老师ID =||=techJobName =||= 头衔 =|| ||= hasPrivateCourse =||= 是否有私课,1:有,0:没有 =||=techDesc =||= 老师描述 =|| ||= techIconUrl =||= 老师等级icon =||= =||= =|| [[BR]] === 4.2老师/达人主页(wap) === 开发环境:http://dev15.pclady.com.cn:85/app/teacher/techInfo.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/teacher/techInfo.do [[BR]] **说明** >直播课和预告终端页[[BR]] **缓存时间** >0分钟 **是否登录** > 是 **提交方式** >GET **数据来源** > 后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||techId||老师ID||String||""||是|| **返回** {{{#!java { "status": 0, "msg": "请求成功", "data": { "shareUrl": "http://wap.pclady.com.cn/111.html", "techId": 1111, "techJobName": "××御用化妆师", "techNickName": "老师姓名", "techIconUrl": "http://img.pconline.com.cn/7.jpg", "techDesc": "老师描述", "techHeadUrl":"老师头像地址", "flowerTotal":"粉丝数", "isFollow": 1,//0:未关注,1:已关注 "followTotal":100, "voiceUrl": "语音地址", "courseTotal":100,//课程数 "courseList": [//视频教程列表 { "courseId": 11, "liveType": 1,//1:直播,2:预告,3:视频教程,4:回顾视频 "liveTime": "6'33''", "imageUrl": "http://img.pconline.com.cn/7.jpg", "title": "课程标题", "watchTotal":100,//观看数 "supportTotal":100,//点赞数 } ], "opus":[{"opusImageUrl": "作品图片地址"}] } } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| ||= opus =||= 学员作品列表 =||=studyId =||= 学员ID =|| [[BR]] ---------- == 5.个人中心 == === 5.1用户信息 === 开发环境:http://dev15.pclady.com.cn:85/app/account/getUserInfo.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/account/getUserInfo.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/account/getUserInfo.do **说明** >获取用户信息 **缓存时间** >15分钟 **提交方式** >GET **是否登录** > 是 **数据来源** > 后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| **返回** {{{#!java { "status": 0, "msg": "请求成功", "data": { "userType": 1, "userNickName": "用户昵称", "collectTotal": 260, "followTotal": 56, "sex":1,//1:男,2:女 "birthday":"1989-01-01", "height":150,//身高 "weight":80,//体重 "skin":"肤质", "face":"脸型", "city":"城市", "job":"职位", "hasCourse":1, "techIconUrl": "http://img.pconline.com.cn/7.jpg",//类型为老师时,需要返回 "techHeadUrl":"老师头像地址",//类型为老师时,需要返回 "techJobName": "××御用化妆师"//类型为老师时,需要返回 "classes": { "courseId": 11, "time": 1, "title": "课程标题" } } } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| ||= userType =||= 0:普通,1:老师 =||=collectTotal =||= 收藏数 =|| ||= followTotal =||= 关注数 =||=messageTotal =||= 消息数 =|| ||= freeCourse =||= 免费课程节点,未登录也要返回 =||=classes =||= 最近一节课 =|| ||= hasCourse =||=用来区分是否显示"我的直播课",1:有公开课,0:没有公开课 =||= =||= =|| [[BR]] === 5.2我的直播间 === 开发环境:http://dev15.pclady.com.cn:85/app/account/myLiveList.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/account/myLiveList.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/account/myLiveList.do **说明** >[[BR]] **缓存时间** >0分钟 **是否登录** > 是 **提交方式** >GET **数据来源** > 后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||pageNo||页数,morbot用到,后端接口不需要||int||1||是|| ||pageSize||页面大小||int||10||是|| **返回** {{{#!java { "status": 0, "msg": "请求成功", "pageNo": 1, "pageSize": 20, "total": 100, "data": [{ "liveId":1111//课程ID,就是房间号 "imageUrl":"图片地址", "state":1,//直播课状态 1 未开始 2 直播中 3已结束 "title":"标题", "learnTotal":100,//报名人数 "time":MM.dd HH:mm,//开始时间, "timeCount":120//倒计时, "isLive":1,//0表示假直播,1表示真直播 "courseUrl":"假直播的播放地址"//假直播返回 }] } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| [[BR]] === 5.3我的课程列表 === 开发环境:http://dev15.pclady.com.cn:85/app/account/myCourseList.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/account/myCourseList.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/myCourseList.do **说明** >查询我的课程列表[[BR]] **缓存时间** >0分钟 **是否登录** > 是 **提交方式** >GET **数据来源** > 后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||= type =||= 1:直播课,2:视频课 最多返回最近的20条=||= 类型 =||= 默认值 =||= 是否必须 =|| ||pageNo||页数||int||1||是|| ||pageSize||页面大小||int||10||是|| **返回** {{{#!java { "status": 0, "msg": "请求成功", "pageNo": 1, "pageSize": 20, "total": 100, "data": [{ "courseId":111, "title":"标题名", "state":1,//直播课状态 1 未开始 2 直播中 3已结束 "liveType": 1,//1:直播,2:预告,3:视频教程,4:回顾视频 "imageUrl":"封面图", "price":100, "date":"yyyy-MM-dd hh:mm", "techId":111, "techNickName":"老师昵称" "passportID":111,//老师passportID,直播的时候,根据老师ID来渲染 }] } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| [[BR]] === 5.4课程收藏 === 开发环境:http://dev15.pclady.com.cn:85/app/account/courseCollectionList.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/account/courseCollectionList.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/account/courseCollectionList.do **说明** >课程收藏[[BR]] **缓存时间** >0分钟 **是否登录** > 是 **提交方式** >GET **数据来源** > 后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||pageNo||页数||int||1||是|| ||pageSize||页面大小||int||10||是|| **返回** {{{#!java { "status": 0, "msg": "请求成功", "pageNo": 1, "pageSize": 20, "total": 100, "data": [ { "courseId": 11, "imageUrl": "http://img.pconline.com.cn/7.jpg", "techId": 1111, "techNickName": "老师姓名", "title": "课程标题", "watchTotal": 100, "followTotal":100, "type":1//类型:1:视频课,2:直播 ] } ] } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| ||= followTotal =||= 关注数 =||= watchTotal =||= 观看人数 =|| [[BR]] === 5.5关注列表 === 开发环境:http://dev15.pclady.com.cn:85/app/account/techFollowList.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/account/techFollowList.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/account/techFollowList.do **说明** >老师关注列表[[BR]] **缓存时间** >0分钟 **是否登录** > 是 **提交方式** >GET **数据来源** > 后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||pageNo||页数||int||1||是|| ||pageSize||页面大小||int||10||是|| **返回** {{{#!java { "status": 0, "msg": "请求成功", "pageNo": 1, "pageSize": 20, "total": 100, "data": [ { "techId": 1111, "techJobName": "××御用化妆师", "techNickName": "老师姓名", "techIconUrl": "http://img.pconline.com.cn/7.jpg", "techDesc": "老师描述", "techHeadUrl":"老师头像地址", "privateCourseTotal":1, "viderTotal":1, "followTotal":100, } ] } }}} **返回参数说明** ||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| ||= privateCourseTotal =||= 私课数 =||= viderTotal =||= 视频课数量 =|| ||= followTotal =||= 粉丝 =||= =||= =|| [[BR]] === 5.6修改用户资料 === 开发环境:http://dev15.pclady.com.cn:85/app/account/updateUserInfo.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/account/updateUserInfo.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/account/updateUserInfo.do **说明** >修改用户资料[[BR]] **缓存时间** >0分钟 **是否登录** > 是 **提交方式** >POST **数据来源** > 后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||= nickName =||= 昵称 =||= String =||= "" =||= 是 =|| ||= sex =||= 1:男,2:女 =||= int =||= "2" =||= 否 =|| ||= birthday =||= 生日,格式:YYYY-MM-DD =||= String =||= "" =||= 否 =|| ||= height =||= 身高 =||= int =||= "" =||= 否 =|| ||= weight =||= 体重 =||= int =||= "" =||= 否 =|| ||= skin =||= 肤质,0:混合性、1:油性、2:干性、3:中性、4:敏感性 =||= int =||= "" =||= 否 =|| ||= face =||= 脸型 ,0:鹅蛋型脸、1:圆脸、2:方脸、3:长脸=||= int =||= "" =||= 否 =|| ||= city =||= 城市编号 =||= String =||= "" =||= 否 =|| ||= job =||= 职业 =||= int =||= "" =||= 否 =|| **返回** {{{#!java { "status": 0, "msg": "请求成功", } }}} **返回参数说明** [[BR]] ---------- == 6.直播 == === 6.1进入课程直播 === 开发环境:http://dev15.pclady.com.cn:85/app/live/enterRoom.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/live/enterRoom.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/live/enterRoom.do **说明** >进入直播室[[BR]] **缓存时间** >0分钟 **是否登录** > 是 **提交方式** >POST **数据来源** > 后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||= courseId =||= 课程号 =||= String =||= "" =||= 是 =|| **返回** {{{#!java { "status": 0, "msg": "请求成功",-2:未开始,-3:已结束,-1:其它错误。 "total":100//直播室总人数 "chatRoomId":"群组ID",//即时聊天用到 "supportTotal":100//点赞人数 } }}} **返回参数说明** [[BR]] === 6.2结束课程 === 开发环境:http://dev15.pclady.com.cn:85/app/live/leaveRoom.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/live/leaveRoom.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/live/leaveRoom.do **说明** >离开直播室[[BR]] **缓存时间** >0分钟 **是否登录** > 是 **提交方式** >POST **数据来源** > 后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||= courseId =||= 课程号 =||= String =||= "" =||= 是 =|| ||= isEnd =||= 是否结束,老师需要带这个参数,为1时表示老师主动结束 =||= String =||= "" =||= 否 =|| **返回** {{{#!java { "status": 0, "msg": "请求成功", } }}} **返回参数说明** [[BR]] === 6.3开始直播 === 开发环境:http://dev15.pclady.com.cn:85/app/live/startLive.do [[BR]] 线上环境:http://modern.pclady.com.cn/app/live/startLive.do [[BR]] mrobot地址:http://mrobot.pclady.com.cn/modern/x/modern.pclady.com.cn/app/live/startLive.do **说明** >开始直播的时候,发送群组ID,只有老师才调用这个接口[[BR]] **缓存时间** >0分钟 **是否登录** > 是 **提交方式** >POST **数据来源** > 后台 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| ||= courseId =||= 房间号 =||= String =||= "" =||= 是 =|| ||= chatRoomId =||= 群组ID,创建直播的时候需要新建一个群组,用于即时聊天 =||= String =||= "" =||= 是 =|| **返回** {{{#!java { "status": 0, "msg": "请求成功", "total":100//直播室总人数 } }}} **返回参数说明** [[BR]] ---------- == 7.其它 == === 7.1关于我们(wap,制作) === === 7.2帮助中心(wap,制作) ===