wiki:pclady_modern1.0.0_api

Context Navigation

Version 31 (modified by caomenglin, 10 years ago) (diff)
--

摩登学院1.0.0接口文档

mrobot代理环境说明：

192.168.10.198：1080(192.168.74.80)
192.168.10.199 端口为 1080 连的是dev40的开发环境（192.168.75.40）
ps1:未到qa阶段，连开发环境调试（若仅做代理，mrobot不存在真正的处理文件，只作转发的功能）
ps2:common_session_id都是在cookies中添加此参数，测试环境为common_session_id1

框架
 设计稿地址
 终端协议

1.公用接口

1.1新增用户

开发环境： http://dev15.pclady.com.cn/app/addUser.jsp
线上环境： http://modern.pclady.com.cn/app/addUser.jsp

说明

初次登录后，通知平台添加用户

缓存时间

0

提交方式

POST

是否登录

是

数据来源

passport

参数

参数名	参数含义	类型	默认值	是否必须

{
  "status":0,
  "msg":"请求成功",
  "sig":"sig"
}

返回参数说明

参数名	参数含义
status	0:成功，-1：失败原因
sig	腾讯生成的sig

2.2启动上报

开发环境： http://dev15.pclady.com.cn/app/reportStartUp.jsp
线上环境： http://modern.pclady.com.cn/app/reportStartUp.jsp

说明

当天用户第一次启动时，需要上报一次。便于判断活跃度，以后发送通知时会用到

缓存时间

0

提交方式

POST

是否登录

是

数据来源

魔方token

参数

参数名	参数含义	类型	默认值	是否必须
type	客户端类型	int	""	否	1:IOS,2:Android
token	魔方推送apns token	String	""	否	IOS为魔方的token,安卓为deviceid

{
  "status":0,
  "msg":"请求成功"
}

返回参数说明

参数名	参数含义	参数名	参数含意

2.首页

2.1首页

开发环境： http://dev15.pclady.com.cn:8004/app/index.jsp
线上环境： http://modern.pclady.com.cn/app/index.jsp
mrobot地址： http://mrobot.pclady.com.cn/x-300/modern/app/index.jsp

说明

根据需求文档返回对应的节点
由于需要查询正在直播的视频，先不考虑缓存
teacher和data节点由mrobot分别调用老师列表接口和首页热门课程组成。后端不需要返回
分页查询的参数只有mrobot用到

缓存时间

0

提交方式

GET

是否登录

否

数据来源

摩登后台

参数

参数名	参数含义	类型	默认值	是否必须	说明
pageNo	页数，morbot用到，后端接口不需要	int	1	是
pageSize	页面大小	int	10	是

{
    "status": 0,
    "msg": "请求成功",
    "focus": [
        {
            "typeName": "焦点图类型",
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "url": "外链url",
            "contentId": "14324"
        }
    ],
    "tagList":[
        {
                        "tagId":111,
                        "tagName":标签名
        }
    ],
    "enter":[
        {
                        "typeName":"APP内页地址",
                        "imageUrl":"http://img.pconline.com.cn/7.jpg",
                        "url":"外链url"
                        "title":"功能名",
          "contentId": "14324"
        }
    ],
    "hotImage":{
                        "typeName":"APP内页地址",
                        "imageUrl":"http://img.pconline.com.cn/7.jpg",
                        "url":"外链url",
          "contentId": "14324"
    },
    "todayLiveVideo": [
        {
            "courseId": 11,
            "liveType": 1,
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "techId": 1111,
            "followTotal":2,//关注人数
            "techJobName": "××御用化妆师",
            "techNickName": "老师姓名",
            "techIconUrl": "http://img.pconline.com.cn/7.jpg",
            "techType": 1,
            "title": "课程标题",
            "desc":"课程描述"
            "startTime": "MM.dd hh:mm",
            "watchTotal": 100
            "timerTotal":"倒计时
        }
    ],
    "teacher":{
        [
                {
            "techId": 111,
            "techJobName": "××御用化妆师",
            "techNickName": "老师姓名",
            "techIconUrl": "http://img.pconline.com.cn/7.jpg",
            "techType": 1
        }
        ]
    },
    "chosenVideo": [
        {
            "courseId": 11,
            "liveTime": "6'33''",
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "techId": 1111,
            "techJobName": "××御用化妆师",
            "techNickName": "老师姓名",
            "techIconUrl": "http://img.pconline.com.cn/7.jpg",
            "techType": 1,
            "title": "课程标题",
            "watchTotal": 100,
            "tag": [
            {
                "tagId": 11,
                "tagName": "标签"
            }
        ]
        }
    ],
    "makeupCourse":[
        {
            "courseId": 11,
            "liveTime": "6'33''",
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "techId": 1111,
            "techJobName": "××御用化妆师",
            "techNickName": "老师姓名",
            "techIconUrl": "http://img.pconline.com.cn/7.jpg",
            "techType": 1,
            "title": "课程标题",
            "watchTotal": 100
        }
    ]
    "data": [
        {
            "courseId": 11,
            "liveTime": "6'33''",
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "techId": 1111,
            "techJobName": "××御用化妆师",
            "techNickName": "老师姓名",
            "techIconUrl": "http://img.pconline.com.cn/7.jpg",
            "techType": 1,
            "title": "课程标题",
            "watchTotal": 100
        }
    ]
}

返回参数说明

参数名	参数含义	参数名	参数含意
typeName	直播课:liveCourse，视频课程:videoCourse，老师:teach，标签:tagInfo，外链:webview	focus	焦点图节点，返回5张焦点图
liveType	1:直播,2:预告	imageUrl	liveVideo节点中为封面图
techID	老师ID	techJobName	头衔
startTime	如果为预告，要返回开始时间	watchTotal	如果是直播，返回观看人数
techIconUrl	老师等级icon	techType	老师类型，1：老师，2：达人
teacher	老师推荐节点，7条	chosenVideo	精选直播课节点，6条
liveTime	视频时长	tag	标签，最多三个
hotVideo	热点视频节点	tag	标签，最多三个
makeupCourse	化妆课程	hotTeacher	人气都是

2.2首页热门课程

开发环境： http://dev15.pclady.com.cn:8004/app/hotCourseList.jsp
线上环境： http://modern.pclady.com.cn/app/hotCourseList.jsp

说明

根据需求文档返回对应的节点

缓存时间

15

提交方式

GET

是否登录

否

数据来源

摩登后台

参数

参数名	参数含义	类型	默认值	是否必须	说明
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是

{
    "status": 0,
    "msg": "请求成功",
    "data": [
        {
            "courseId": 11,
            "liveTime": "6'33''",
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "techId": 1111,
            "techJobName": "××御用化妆师",
            "techNickName": "老师姓名",
            "techIconUrl": "http://img.pconline.com.cn/7.jpg",
            "techType": 1,
            "title": "课程标题",
            "watchTotal": 100
        }
    ]
}

返回参数说明

参数名	参数含义	参数名	参数含意
typeName	直播课:liveCourse，视频课程:videoCourse，老师:teach，标签:tagInfo，外链:webview	focus	焦点图节点，返回5张焦点图
liveType	1:直播,2:预告	imageUrl	liveVideo节点中为封面图
techID	老师ID	techJobName	头衔
startTime	如果为预告，要返回开始时间	watchTotal	如果是直播，返回观看人数
techIconUrl	老师等级icon	techType	老师类型，1：老师，2：达人
teacher	老师推荐节点，7条	chosenVideo	精选直播课节点，6条
liveTime	视频时长	tag	标签，最多三个
hotVideo	热点视频节点	tag	标签，最多三个
makeupCourse	化妆课程	hotTeacher	人气都是

3.公开课

3.1获取课程列表

开发环境： http://dev15.pclady.com.cn/app/courseList.jsp
线上环境： http://modern.pclady.com.cn/app/courseList.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/courseList.jsp

说明

获取公开课列表,默认加载10条
显示顺序：正在直播和预告优先显示。其余按回顾直播课的开始时间、视频教程的启用时间，新到旧排列

由于需要查询正在直播的视频，先不考虑缓存

缓存时间

0分钟

提交方式

GET

是否登录

否

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是

{
    "status": 0,
    "msg": "请求成功",
    "pageNo": 1,
    "pageSize": 20,
    "total": 100,
    "todayLive":{
                                "courseId": 11,
            "liveType": 1,
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "techId": 1111,
            "techJobName": "××御用化妆师",
            "techNickName": "老师姓名",
            "techIconUrl": "http://img.pconline.com.cn/7.jpg",
            "techType": 1,
            "title": "课程标题",
            "desc":"课程描述"
            "watchTotal": 100
    },
    "todayYG"[{
                                "courseId": 11,
            "liveType": 1,
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "techId": 1111,
            "techJobName": "××御用化妆师",
            "techNickName": "老师姓名",
            "techIconUrl": "http://img.pconline.com.cn/7.jpg",
            "techType": 1,
            "title": "课程标题",
            "startTime": "MM.dd hh:mm",
            "timerTotal":"倒计时"
    }]
    "data": [
        {
            "courseId": 11,
            "liveType": 1,
            "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",
            "techType": 1,
            "title": "课程标题",
            "watchTotal": 100,
            "tag": [
            {
                "tagId": 11,
                "tagName": "标签"
            }
        ]
        }
    ]
}

返回参数说明

参数名	参数含义	参数名	参数含意
liveType	1:直播,2:预告,3:视频教程	liveTime	视频时长
imageUrl	封面图	watchTotal	如果是直播，返回观看人数
techID	老师ID	techJobName	头衔
startTime	如果为预告，要返回开始时间	tag	标签，最多三个
techIconUrl	老师等级icon	techType	老师类型，1：老师，2：达人
todayLive	正在直播的视频节点，没有时不返回	todayYG	今日预告节点，没有时不返回

3.2直播课终端页(wap)

开发环境： http://dev15.pclady.com.cn/app/liveCourseInfo.jsp
线上环境： http://modern.pclady.com.cn/app/liveCourseInfo.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/liveCourseInfo.jsp

说明

直播课和预告终端页

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
courseId	课程ID	String	""	是

{
    "status": 0,
    "msg": "请求成功",
    "data": {
        "courseId": 11,
        "liveType": 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,
        "type": 1,
        "oldPrice": 100,
        "price": 50,
        "signUpTotal": 100,
        "techId": 1111,
        "techJobName": "××御用化妆师",
        "techNickName": "老师姓名",
        "techIconUrl": "http://img.pconline.com.cn/7.jpg",
        "techType": 1,
        "techDesc": "老师描述",
        "isFollow": 1,
        "isSupport": 1,
        "followTotal":100,
        "supportTotal":100,
        "rewardTotal":100,
        "phoneNum":"13333333333",
        "userName":"下单时用过的称呼",
        "tag": [
            {
                "tagId": 11,
                "tagName": "标签"
            }
        ],
        "courseDesc": "课程描述",
        "notice":"上课需知",
        "courseList": [
            {
                "courseId": 11,
                "liveType": 1,
                "liveTime": "6'33''",
                "startTime": "MM.dd hh:mm",
                "imageUrl": "http://img.pconline.com.cn/7.jpg",
                "title": "课程标题"
            }
        ],
        "followUserIdList": [
            "111",
            "222"
        ]
    }
}

返回参数说明

参数名	参数含义	参数名	参数含意
liveType	1:直播,2:预告	courseUrl	视频地址
startTime	开始时间，预告需要返回	timeCount	倒计时，单位为秒，预告需要返回
shareUrl	分享的wap地址	isSignUp	是否报名，1：是，0：否
title	课程标题	isCollect	是否收藏，1：是，0：否
type	上课方式，1:直播课,2:一对一	price	价格
oldPrice	原价	signUpTotal	报名人数
techID	老师ID	techJobName	头衔
techIconUrl	老师等级icon	techType	老师类型，1：老师，2：达人
isFollow	是否关注老师，1：是，0：否	tag	标签，最多三个
isSupport	是否点赞，1：是，0：否	courseList	相关课程，两条
followUserIdList	报名用户的ID，最多8条	rewardTotal	打赏人数
followTotal	关注人数	supportTotal	点赞人数
userName	下单时用过的称呼	phoneNum	下单时用过的手机

3.3直播课终端页问答列表(wap)

开发环境： http://dev15.pclady.com.cn/app/requestList.jsp
线上环境： http://modern.pclady.com.cn/app/requestList.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/requestList.jsp

说明

问答列表

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
courseId	课程ID	String	""	是
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是

{
    "status": 0,
    "msg": "请求成功",
    "data": [
        {
            "requestId": 11,
            "userId": 111,
            "nickName": "昵称",
            "message": "问题内容",
            "techIconUrl": "http://img.pconline.com.cn/7.jpg",
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "createTime": "MM-dd hh:mm",
            "supportTotal": 10
        }
    ]
}

返回参数说明

参数名	参数含义	参数名	参数含意

3.4发表问题

开发环境： http://dev15.pclady.com.cn/app/sendRequest.jsp
线上环境： http://modern.pclady.com.cn/app/sendRequest.jsp

说明

发表问题

缓存时间

0分钟

提交方式

POST

是否登录

是

数据来源

整形库编辑后台

参数

参数名	参数含义	类型	默认值	是否必须	说明
courseId	课程ID	string	""	是
message	内容	string	""	是	回复内容
imageURL	图片地址，多个时用英文逗号隔开，最多三张	string	""	否	回复时不需要传

{
  "status":0,
  "msg":"请求成功"
}

返回参数说明

参数名	参数含义	参数名	参数含意

3.5收藏/取消收藏

开发环境： http://dev15.pclady.com.cn/app/collection.jsp
线上环境： http://modern.pclady.com.cn/app/collection.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/collection.jsp

说明

收藏/取消收藏

缓存时间

0分钟

提交方式

POST

是否登录

是

数据来源

参数

参数名	参数含义	类型	默认值	是否必须
courseId	ID，批量取消收藏时，用英文逗号隔开	String	""	是
type	类型：1：视频，2：一对一	int	""	是
operation	操作：1：收藏，2：取消收藏	int	""	是

{
  "status":0,
  "msg":"请求成功"
  "state":1
}

返回参数说明

参数名	参数含义	参数名	参数含意
state	1:收藏，0：未收藏，返回状态是为了防止网络不太稳定的时候，连续点击，客户端状态更新错误，批量操作不需要返回

3.6关注/取消关注老师

开发环境： http://dev15.pclady.com.cn/app/followTech.jsp
线上环境： http://modern.pclady.com.cn/app/followTech.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/followTech.jsp

说明

关注/取消关注老师

缓存时间

0分钟

提交方式

POST

是否登录

是

数据来源

参数

参数名	参数含义	类型	默认值	是否必须
techId	ID，批量取消关注时，用英文逗号隔开	String	""	是
operation	操作：1：关注，2：取消关注	int	""	是

{
  "status":0,
  "msg":"请求成功"
  "state":1
}

返回参数说明

参数名	参数含义	参数名	参数含意
state	1:关注，0：未关注，返回状态是为了防止网络不太稳定的时候，连续点击，客户端状态更新错误

3.7点赞

开发环境： http://dev15.pclady.com.cn/app/support.jsp
线上环境： http://modern.pclady.com.cn/app/support.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/support.jsp

说明

点赞

缓存时间

0分钟

提交方式

POST

是否登录

直播课报名之后才可以点赞；普通视频不需要登录也可以点赞。问答点赞也需要登录

数据来源

参数

参数名	参数含义	类型	默认值	是否必须
courseId	ID	String	""	是

{
  "status":0,
  "msg":"请求成功",
  "supportTotal":100
}

返回参数说明

参数名	参数含义	参数名	参数含意
supportTotal	点赞成功后要返回点赞总数	参数名	参数含意

3.8课后答疑(wap)

开发环境： http://dev15.pclady.com.cn/app/answerList.jsp
线上环境： http://modern.pclady.com.cn/app/answerList.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/answerList.jsp

说明

课后答疑列表

缓存时间

0分钟

是否登录

否

提交方式

GET

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
courseId	课程ID	String	""	是
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是

{
    "status": 0,
    "msg": "请求成功",
    "info": {
        "courseId": 11,
        "liveType": 1,
        "title": "课程标题",
        "imageUrl": "封面图",
        "startTime": "YYYY-MM-dd hh:mm",
        "shareUrl": "http://wap.pclady.com.cn/111.html",
        "techId": 1111,
        "techJobName": "××御用化妆师",
        "techNickName": "老师姓名",
        "techIconUrl": "http://img.pconline.com.cn/7.jpg",
        "courseDesc": "课程描述"
    },
    "data": [
        {
            "answerId": 11,
            "type": 1,
            "message": "答疑内容",
            "customerHead": "小助手头像",
            "userHead": "用户头像",
            "imageUrl": "图片",
            "voiceUrl": "语音地址",
            "voiceState": 1,
            "voiceLength": 10,
            "publicNumber": "公众号"
        }
    ]
}

返回参数说明

参数名	参数含义	参数名	参数含意
type	1:问答小助手,2:用户	voiceState	1：已读，0：未读
voiceLength	语音长度	publicNumber	公众号

3.9根据标签获取公开课列表

开发环境： http://dev15.pclady.com.cn/app/courseListWithTag.jsp
线上环境： http://modern.pclady.com.cn/app/courseListWithTag.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/courseListWithTag.jsp

说明

获取公开课列表,默认加载10条
显示顺序：正在直播和预告优先显示。其余按回顾直播课的开始时间、视频教程的启用时间，新到旧排列

由于需要查询正在直播的视频，先不考虑缓存

缓存时间

0分钟

提交方式

GET

是否登录

否

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是
tagId	标签Id	int	10	是

{
    "status": 0,
    "msg": "请求成功",
    "pageNo": 1,
    "pageSize": 20,
    "total": 100,
    "data": [
        {
            "courseId": 11,
            "liveType": 1,
            "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",
            "techType": 1,
            "title": "课程标题",
            "watchTotal": 100,
            "tag": [
            {
                "tagId": 11,
                "tagName": "标签"
            }
        ]
        }
    ]
}

返回参数说明

参数名	参数含义	参数名	参数含意
liveType	1:直播,2:预告,3:视频教程	liveTime	视频时长
imageUrl	封面图	watchTotal	如果是直播，返回观看人数
techID	老师ID	techJobName	头衔
startTime	如果为预告，要返回开始时间	tag	标签，最多三个
techIconUrl	老师等级icon	techType	老师类型，1：老师，2：达人

3.10打赏

开发环境： http://dev15.pclady.com.cn/app/createReward.jsp
线上环境： http://modern.pclady.com.cn/app/createReward.jsp

说明

创建打赏订单

缓存时间

0

提交方式

POST

是否需要登录

是

数据来源

整形库编辑后台

参数

参数名	参数含义	类型	默认值	是否必须
courseId	课程id	String	""	是
amount	打赏金额	int	""	是
content	打赏理由	String	""	是
r	时间截	String	""	是
sign	MD5加密串	String	""	是

{
  "status":0,
  "msg":"请求成功",
  "orderID":"12424234234",
  "orderNO":"流水号ID"
}

3.11支付结果提交

开发环境： http://dev15.pclady.com.cn/app/submitPayResult.jsp
线上环境： http://modern.pclady.com.cn/app/submitPayResult.jsp

说明

支付完后，客户端发送日志给服务端

缓存时间

0

提交方式

POST

是否需要登录

是

数据来源

整形库编辑后台

参数

参数名	参数含义	类型	默认值	是否必须
orderNO	流水号ID	String	""	是
payTime	支付时间：yyyyMMddhhmmss	String	""	是
payStatus	支付状态,支付返回的状态0:成功，-1:失败,-2：取消	String	""	是
payType	支付类型 1=支付宝	String	""	是
payMessage	支付信息，支付结果信息，如支付成功，取消支付，支付失败	String	""	是
r	时间截	String	""	是
sign	MD5加密串	String	""	是

{
  "status":0,
  "msg":"请求成功",
}

3.12报名

开发环境： http://dev15.pclady.com.cn/app/createOrder.jsp
线上环境： http://modern.pclady.com.cn/app/createOrder.jsp

说明

报名，用于创建订单

缓存时间

0

提交方式

POST

是否需要登录

是

数据来源

整形库编辑后台

参数

参数名	参数含义	类型	默认值	是否必须
courseId	课程id	String	""	是
userName	称呼	int	""	是
phoneNum	手机号码	String	""	是
remind	是否短信提醒，1：提醒，0：不提醒	String	""	是
techId	老师ID，一对一才需要传此参数	String	""	否
dateId	上课日期，一对一才需要传此参数	String	""	否
timeId	上课时间段，一对一才需要传此参数	String	""	否
r	时间截	String	""	是
sign	MD5加密串	String	""	是

{
    "status": 0,
    "msg": "请求成功",
    "orderID ": 1111,
    "orderNO": "流水号ID"
}

3.13获取打赏信息

开发环境： http://dev15.pclady.com.cn/app/rewardInfo.jsp
线上环境： http://modern.pclady.com.cn/app/rewardInfo.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/rewardInfo.jsp

说明

打赏时获取随机出金额，和以及对应的描述文字

缓存时间

60分钟

提交方式

GET

是否登录

否

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是

{
    "status": 0,
    "msg": "请求成功",
    "amount": [
        1.88,
        2.88,
        6.66
    ],
    "message": [
        "你太棒了",
        你真的很棒
    ]
}

返回参数说明

3.14取消用户订单

开发环境： http://dev15.pclady.com.cn/app/cancelOrder.jsp
线上环境： http://modern.pclady.com.cn/app/cancelOrder.jsp
mrobot： http://mrobot.pclady.com.cn/x/modern/app/cancelOrder.jsp

说明

取消订单

缓存时间

0

提交方式

GET

是否需要登录

是

数据来源

整形库编辑后台

参数

参数名	参数含义	类型	默认值	是否必须
orderID	订单	String	""	是
r	时间截	String	""	是
sign	MD5加密串	String	""	是

{
  "status":0,
  "msg":"请求成功"
}

3.15商品(wap)

开发环境： http://dev15.pclady.com.cn/app/commodityList.jsp
线上环境： http://modern.pclady.com.cn/app/commodityList.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/commodityList.jsp

说明

缓存时间

0分钟

提交方式

GET

是否登录

否

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是
courseId	课程ID	int	10	是

{
    "status": 0,
    "msg": "请求成功",
    "pageNo": 1,
    "pageSize": 20,
    "total": 100,
    "data": [
        {
            "commodityId":111,
            "imageUrl":"商品图片地址",
                "title":"标题",
                "spec":"规格",
                "price":"价格",
                "state":0,//0:我想要,1:已关注
        }
    ]
}

返回参数说明

参数名	参数含义	参数名	参数含意
liveType	1:直播,2:预告,3:视频教程	liveTime	视频时长
imageUrl	封面图	watchTotal	如果是直播，返回观看人数
techID	老师ID	techJobName	头衔
startTime	如果为预告，要返回开始时间	tag	标签，最多三个
techIconUrl	老师等级icon	techType	老师类型，1：老师，2：达人

3.16发现列表

开发环境： http://dev15.pclady.com.cn/app/findList.jsp
线上环境： http://modern.pclady.com.cn/app/findList.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/findList.jsp

说明

发现列表，获取热点标签和气老师

缓存时间

15分钟

提交方式

GET

是否登录

否

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是

{
    "status": 0,
    "msg": "请求成功",
    "tagList": [{
        "tagId":111,
        "tagName":"标签名"
        "tagImageUrl":"http://img.pconline.com.cn/7.jpg"
    }],
    "hotTeacther": [
        {
                        "techId": 111,
            "techJobName": "××御用化妆师",
            "techNickName": "老师姓名",
            "techIconUrl": "http://img.pconline.com.cn/7.jpg",
            "techType": 1,
            "courseTotal":100,
            "followTotal":2,//关注人数
        }
    ]
}

返回参数说明

tagList	热点标签	hotTeacther	人气老师
techType	1：老师，2：达人	tagImageUrl	标签图片地址

3.17视频课终端页(wap)

开发环境： http://dev15.pclady.com.cn/app/videoCourseInfo.jsp
线上环境： http://modern.pclady.com.cn/app/videoCourseInfo.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/videoCourseInfo.jsp

说明

视频课终端页

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
courseId	课程ID	String	""	是

{
    "status": 0,
    "msg": "请求成功",
    "data": {
        "courseId": 11,
        "title": "课程标题",
        "courseUrl": "http://view.mp4",
        "shareUrl": "http://wap.pclady.com.cn/111.html",
        "isSignUp": 1,
        "isCollect": 1,
        "techId": 1111,
        "techJobName": "××御用化妆师",
        "techNickName": "老师姓名",
        "techIconUrl": "http://img.pconline.com.cn/7.jpg",
        "techType": 1,
        "isFollow": 1,
        "isSupport": 1,
        "followTotal":100,
        "supportTotal":100,
        "rewardTotal":100,
        "courseDesc": "课程描述",
        "isWatch":0
        "courseList": [
            {
                "courseId": 11,
                "liveType": 1,
                "liveTime": "6'33''",
                "startTime": "MM.dd hh:mm",
                "imageUrl": "http://img.pconline.com.cn/7.jpg",
                "title": "课程标题"
            }
        ],
        "commodityList": [//商品
            {
                "commodityId":111,
                "imageUrl":"商品图片地址",
                "title":"标题",
                "spec":"规格",
                "price":"价格",
                "state":0,//0:我想要,1:已关注
            }
        ]
    }
}

返回参数说明

参数名	参数含义	参数名	参数含意
liveType	1:直播,2:预告	courseUrl	视频地址
startTime	开始时间，预告需要返回	timeCount	倒计时，单位为秒，预告需要返回
shareUrl	分享的wap地址	isWatch	是否观看过，1：是，0：否
title	课程标题	isCollect	是否收藏，1：是，0：否
type	上课方式，1:直播课,2:一对一	price	价格
oldPrice	原价	signUpTotal	报名人数
techID	老师ID	techJobName	头衔
techIconUrl	老师等级icon	techType	老师类型，1：老师，2：达人
isFollow	是否关注老师，1：是，0：否	tag	标签，最多三个
isSupport	是否点赞，1：是，0：否	courseList	相关课程，两条

4.老师/达人

5.1获取老师表

开发环境： http://dev15.pclady.com.cn/app/techerList.jsp
线上环境： http://modern.pclady.com.cn/app/techerList.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/techerList.jsp

说明

获取老师列表，按老师主页浏览量、老师课程（公开课、视频课、私课）数量综合评估，从高到低排列

缓存时间

15分钟

提交方式

GET

是否登录

否

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是
techType	老师类型，0为全部	int	0	否
isTop	为1时，表示查询置顶的，首页查询人气老师时用到	int	0	否

{
    "status": 0,
    "msg": "请求成功",
    "pageNo": 1,
    "pageSize": 20,
    "total": 100,
    "type"[
        {
                "techType":1,
                "title":"老师"
        }
    ]
    "data": [
        {
            "techId": 1111,
                        "techJobName": "××御用化妆师",
                        "techNickName": "老师姓名",
                        "techIconUrl": "http://img.pconline.com.cn/7.jpg",
                        "techType": 1,
                        "techDesc": "老师描述",
                        "hasPrivateCourse":1,
            "followTotal":2,//关注人数
        }
    ]
}

返回参数说明

参数名	参数含义	参数名	参数含意
techID	老师ID	techJobName	头衔
hasPrivateCourse	是否有私课,1:有，0：没有	techDesc	老师描述
techIconUrl	老师等级icon	techType	老师类型，1：老师，2：达人

4.2老师/达人主页(wap)

开发环境： http://dev15.pclady.com.cn/app/techInfo.jsp
线上环境： http://modern.pclady.com.cn/app/techInfo.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/app/techInfo.jsp

说明

直播课和预告终端页

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
techId	老师ID	String	""	是

{
    "status": 0,
    "msg": "请求成功",
    "data": {
                "shareUrl": "http://wap.pclady.com.cn/111.html",
        "techId": 1111,
        "techJobName": "××御用化妆师",
        "techNickName": "老师姓名",
        "techIconUrl": "http://img.pconline.com.cn/7.jpg",
        "techType": 1,
        "techDesc": "老师描述",
        "isFollow": 1,
        "followTotal":100,
        "voiceUrl": "语音地址",
        "voiceLength": 10,
        "courseTotal":100,//课程数
        "courseList": [
            {
                "courseId": 11,
                "liveType": 1,
                "liveTime": "6'33''",
                "imageUrl": "http://img.pconline.com.cn/7.jpg",
                "title": "课程标题",
                "watchTotal":100
            }
        ],
        "chatCourseList": [
            "courseId": 11,
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "price": 1111,
            "grade": 1,
            "title": "课程标题",
            "desc": "描述",
            "sutdyTotal": 100
        ],
        "opus":{
                        "opusId":11,
                        "studyId":111,
                        "studyNickName":"学员昵称",
                        "opusDes":"作品文字",
                        "opusImageUrl":"作品图片地址",
                        "courseTitle":"标题",
                        "techReply":"老师点评"
        }
        
    }
}

返回参数说明

参数名	参数含义	参数名	参数含意
courseList	视频教程列表	chatCourseList	一对一课程列表
opus	学员作品列表	studyId	学员ID

5.个人中心

5.1用户信息

开发环境： http://dev15.pclady.com.cn/app/getUserInfo.jsp
线上环境： http://modern.pclady.com.cn/app/getUserInfo.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/getUserInfo.jsp

说明

获取用户信息

缓存时间

15分钟

提交方式

GET

是否登录

是

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须

{
    "status": 0,
    "msg": "请求成功",
    "data": {
        "userType": 1,
        "userNickName": "用户昵称",
        "collectTotal": 260,
        "followTotal": 56,
        "messageTotal": 20,
        "isSignIn":1,
        "isTesting":1,
        "sex":1,
        "birthday":"1989-01-01",
        "height":150,
        "weight":80,
        "skin":"肤质",
        "face":"脸型",
        "city":"城市",
        "job":"职位",
        "classes": {
            "courseId": 11,
            "time": 1,
            "title": "课程标题"
        }
    }
}

返回参数说明

参数名	参数含义	参数名	参数含意
userType	0:普通,1:老师,2:达人	collectTotal	收藏数
followTotal	关注数	messageTotal	消息数
freeCourse	免费课程节点，未登录也要返回	classes	最近一节课
isSignIn	是否签到,1:是，0：未	isTesting	是否测试,1:是，0：未

5.2我的直播间

开发环境： http://dev15.pclady.com.cn/app/myLiveList.jsp
线上环境： http://modern.pclady.com.cn/app/myLiveList.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/myLiveList.jsp

说明

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须

{
    "status": 0,
    "msg": "请求成功",
    "data": [{
                "liveId":1111
                "imageUrl":"图片地址",
                "state":1,//0:未开始,1:进行中,2:已结束
                "title":"标题",
                "learnTotal":100,//报名人数
                "time":YY.MM HH:mm,//开始时间
    }]
}

返回参数说明

参数名	参数含义	参数名	参数含意

5.3我的课程列表

开发环境： http://dev15.pclady.com.cn/app/myCourseList.jsp
线上环境： http://modern.pclady.com.cn/app/myCourseList.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/myCourseList.jsp

说明

查询我的课程列表

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
type	1:直播课,2:视频课最多返回最近的20条	类型	默认值	是否必须
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是

{
    "status": 0,
    "msg": "请求成功",
    "pageNo": 1,
    "pageSize": 20,
    "total": 100,
    "data": [{
                "courseId":111,
                "title":"标题名",
                "state":1,//0:未开始,1:进行中,2:已结束
                "imageUrl":"封面图",
                "price":100,
                "date":"yyyy-MM-dd hh:mm",
                "techId":111,
                "techNickName":"老师昵称"
    }]
}

返回参数说明

参数名	参数含义	参数名	参数含意

5.4资产管理

开发环境： http://dev15.pclady.com.cn/app/myRewardList.jsp
线上环境： http://modern.pclady.com.cn/app/myRewardList.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/myRewardList.jsp

说明

查询我的资产

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
type	0:支出,1:收入，老师和达人才有收入	int	0	是
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是

{
    "status": 0,
    "msg": "请求成功",
    "pageNo": 1,
    "pageSize": 20,
    "total": 100,
    "income":100,
    "expenditure":100,
    "data": [{
                "rewardId":111,
                "amount":5,
                "title":"标题",
                "orderId":120
                "techId":111,
                "techNickName":"老师昵称",
                "payTime":"yyyy-MM-dd hh:mm:ss",
                "userId":111,
                "userNickName":"用户昵称"
    }]
}

返回参数说明

参数名	参数含义	参数名	参数含意
income	收入	expenditure	支出
amount	赏金	techId	techId和techNickName类型为支出才需要返回
userId	userId和userNickName类型为收入才需要返回	payTime	支付时间
orderId	流水号，类型为支出需要返回	rewardId	资产ID

5.5提现记录

开发环境： http://dev15.pclady.com.cn/app/getMoneyList.jsp
线上环境： http://modern.pclady.com.cn/app/getMoneyList.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/getMoneyList.jsp

说明

查询我的订单

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是

{
    "status": 0,
    "msg": "请求成功",
    "pageNo": 1,
    "pageSize": 20,
    "total": 100,
    "data": [{
                "rewardId":111,
                "amount":5,
                "time":"yyyy-MM-dd hh:mm:ss",
                "state":0
    }]
}

返回参数说明

参数名	参数含义	参数名	参数含意
amount	提现金额	state	0:待审核,1:审核通过,2:已完成

5.6课程收藏

开发环境： http://dev15.pclady.com.cn/app/courseCollectionList.jsp
线上环境： http://modern.pclady.com.cn/app/courseCollectionList.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/courseCollectionList.jsp

说明

课程收藏

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是
type	类型：1：视频，2：一对一	int	1	是

{
    "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
        ]
        }
    ]
}

返回参数说明

参数名	参数含义	参数名	参数含意
one2one	一对一节点	video	视频教程
followTotal	关注数	sutdyTotal	已学人数

5.7关注列表

开发环境： http://dev15.pclady.com.cn/app/techFollowList.jsp
线上环境： http://modern.pclady.com.cn/app/techFollowList.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/techFollowList.jsp

说明

老师关注列表

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
pageNo	页数	int	1	是
pageSize	页面大小	int	10	是

{
    "status": 0,
    "msg": "请求成功",
    "pageNo": 1,
    "pageSize": 20,
    "total": 100,
    "data": [
        {
            "techId": 1111,
            "techJobName": "××御用化妆师",
            "techNickName": "老师姓名",
            "techIconUrl": "http://img.pconline.com.cn/7.jpg",
            "techType": 1,
            "techDesc": "老师描述",
            "privateCourseTotal":1,
            "viderTotal":1,
            "followTotal":100,
        }
    ]
}

返回参数说明

参数名	参数含义	参数名	参数含意
privateCourseTotal	私课数	viderTotal	视频课数量
followTotal	粉丝	techType	老师类型。1：老师，2：达人。

5.8注册引导(wap)

开发环境： http://dev15.pclady.com.cn/app/registerGuide.jsp
线上环境： http://modern.pclady.com.cn/app/registerGuide.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/registerGuide.jsp

说明

获取测试结果

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

参数名	类型	默认值	是否必须
待定	String	""	是
待定	String	""	是
待定	String	""	是

{
    "status": 0,
    "msg": "请求成功",
    "pageNo": 1,
    "data": {
        "keyWord": [
            "美白",
            "画眉"
        ],
        "desc": "测试结果描述",
        "cous": [
            {
                "courseId": 11,
                "imageUrl": "http://img.pconline.com.cn/7.jpg",
                "price": 100,
                "grade": 1,
                "title": "课程标题",
                "desc": "描述",
                "sutdyTotal": 100
            }
        ]
    }
}

返回参数说明

参数名	参数含义	参数名	参数含意
isRead	是否已读，1：已读，0：未读	url	跳转的URL

5.9修改用户资料

开发环境： http://dev15.pclady.com.cn/app/updateUserInfo.jsp
线上环境： http://modern.pclady.com.cn/app/updateUserInfo.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/updateUserInfo.jsp

说明

修改用户资料

缓存时间

0分钟

是否登录

是

提交方式

POST

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
nickName	昵称	String	""	否
sex	1:男，2：女	int	""	否
birthday	生日，格式：YYYY-MM-DD	String	""	否
height	身高	int	""	否
weight	体重	int	""	否
skin	肤质	String	""	否
face	脸型	String	""	否
city	城市,一般城市：广东,广州，直辖：北京	String	""	否
job	职业	String	""	否

{
    "status": 0,
    "msg": "请求成功",
}

返回参数说明

6.直播室

6.1进入直播室

开发环境： http://dev15.pclady.com.cn/app/enterRoom.jsp
线上环境： http://modern.pclady.com.cn/app/enterRoom.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/enterRoom.jsp

说明

进入直播室

缓存时间

0分钟

是否登录

是

提交方式

POST

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
roomId	房间号	String	""	是

{
    "status": 0,
    "msg": "请求成功",
    "total":100//直播室总人数
}

返回参数说明

6.2离开直播室

开发环境： http://dev15.pclady.com.cn/app/leaveRoom.jsp
线上环境： http://modern.pclady.com.cn/app/leaveRoom.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/leaveRoom.jsp

说明

离开直播室

缓存时间

0分钟

是否登录

是

提交方式

POST

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
roomId	房间号	String	""	是

{
    "status": 0,
    "msg": "请求成功",
}

返回参数说明

6.3开始直播

开发环境： http://dev15.pclady.com.cn/app/startLive.jsp
线上环境： http://modern.pclady.com.cn/app/startLive.jsp
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/startLive.jsp

说明

开始直播的时候，发送录播文件的ID，便于查询录播地址，直播流，尺寸

缓存时间

0分钟

是否登录

是

提交方式

POST

数据来源

后台

参数

参数名	参数含义	类型	默认值	是否必须
roomId	房间号	String	""	是
fileId	文件ID，用于查询录播文件	String	""	是
url	直播地址	String	""	是
width	录制视频的宽度，用于播放的时候设置尺寸	int	""	是
height	录制视频的高度，用于播放的时候设置尺寸	int	""	是

{
    "status": 0,
    "msg": "请求成功",
}

Context Navigation

Table of Contents

摩登学院1.0.0接口文档

1.公用接口

1.1新增用户

2.2启动上报

2.首页

2.1首页

2.2首页热门课程

3.公开课

3.1获取课程列表

3.2直播课终端页(wap)

3.3直播课终端页问答列表(wap)

3.4发表问题

3.5收藏/取消收藏

3.6关注/取消关注老师

3.7点赞

3.8课后答疑(wap)

3.9根据标签获取公开课列表

3.10打赏

3.11支付结果提交

3.12报名

3.13获取打赏信息

3.14取消用户订单

3.15商品(wap)

3.16发现列表

3.17视频课终端页(wap)

4.老师/达人

5.1获取老师表

4.2老师/达人主页(wap)

5.个人中心

5.1用户信息

5.2我的直播间

5.3我的课程列表

5.4资产管理

5.5提现记录

5.6课程收藏

5.7关注列表

5.8注册引导(wap)

5.9修改用户资料

6.直播室

6.1进入直播室

6.2离开直播室

6.3开始直播

7.其它

7.1关于我们(wap，制作)

7.2帮助中心(wap，制作)

Attachments

Download in other formats: