wiki:pclady_modern1.0.0_api

Version 48 (modified by caomenglin, 10 years ago) (diff)

--

Table of Contents

  1. 1.公用接口
    1. 1.1新增用户
    2. 2.2启动上报
  2. 2.首页
    1. 2.1首页
  3. 3.公开课
    1. 3.1获取课程列表
    2. 3.2直播课终端页(wap)
    3. 3.3直播课终端页问答列表(wap)
    4. 3.4发表问题
    5. 3.5收藏/取消收藏
    6. 3.6关注/取消关注老师
    7. 3.7点赞
    8. 3.8课后答疑(wap)
    9. 3.9根据标签获取公开课列表
    10. 3.10打赏
    11. 3.11支付结果提交
    12. 3.12报名
    13. 3.13获取打赏信息
    14. 3.14取消用户订单
    15. 3.15商品(wap)
    16. 3.16发现列表
    17. 3.17视频课终端页(wap)
  4. 4.老师/达人
    1. 4.1获取老师表
    2. 4.2老师/达人主页(wap)
  5. 5.个人中心
    1. 5.1用户信息
    2. 5.2我的直播间
    3. 5.3我的课程列表
    4. 5.4资产管理
    5. 5.5提现记录
    6. 5.6课程收藏
    7. 5.7关注列表
    8. 5.8修改用户资料
  6. 6.直播
    1. 6.1进入课程直播
    2. 6.2离开课程直播
    3. 6.3开始直播
  7. 7.其它
    1. 7.1关于我们(wap，制作)
    2. 7.2帮助中心(wap，制作)

摩登学院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/account/addUser.do
线上环境： http://modern.pclady.com.cn/app/account/addUser.do

说明

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

缓存时间

0

提交方式

POST

是否登录

是

数据来源

passport

参数

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

返回 

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

返回参数说明

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

2.2启动上报

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

说明

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

缓存时间

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.do
线上环境： http://modern.pclady.com.cn/app/index.do
mrobot地址： http://mrobot.pclady.com.cn/x-300/modern/app/index.do

说明

根据需求文档返回对应的节点
由于需要查询正在直播的视频，先不考虑缓存
pageNo=1时需要返回所有节点，pageNo>1时，只需要返回data节点

缓存时间

0

提交方式

GET

是否登录

否

数据来源

摩登后台

参数

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

返回 

{
    "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 直播课列表 liveList;课程标签列表 tagList;直播课终端页 liveCourseInfo;视频课程终端页 videoCourseInfo;发现页 findList;老师列表 techerList;老师主页 techInfo;外链 webView;标签详情 tagInfo 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/course/courseList.do
线上环境： http://modern.pclady.com.cn/app/course/courseList.do
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/course/courseList.do

说明

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

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

缓存时间

0分钟

提交方式

GET

是否登录

否

数据来源

后台

参数

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

返回 

{
    "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.do
线上环境： http://modern.pclady.com.cn/app/liveCourseInfo.do
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/liveCourseInfo.do

说明

直播课和预告终端页

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

参数名 参数含义 类型 默认值 是否必须
courseId课程IDString""是
inReview= 1：审核状态 0：发布状态int 0 否 ios审核时用到

返回 

{
    "status": 0,
    "msg": "请求成功",
    "data": {
        "courseId": 11,
        "liveType": 1,
        "title": "课程标题",
        "courseUrl": ["http://view.mp4","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/course/requestList.do
线上环境： http://modern.pclady.com.cn/app/course/requestList.do
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/course/requestList.do

说明

问答列表

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

参数名 参数含义 类型 默认值 是否必须
courseId课程IDString""是
pageNo页数int1是
pageSize页面大小int10是

返回 

{
    "status": 0,
    "msg": "请求成功",
    "adminMessage":"管理员消息"//pageNo=1的时候才返回
    "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：老师，2：达人,如果是老师，有这参数
        }
    ]
}

返回参数说明

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


3.4发表问题

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

说明

发表问题

缓存时间

0分钟

提交方式

POST

是否登录

是

数据来源

整形库编辑后台

参数

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

返回 

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

返回参数说明

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

3.5收藏/取消收藏

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

说明

收藏/取消收藏

缓存时间

0分钟

提交方式

POST

是否登录

是

数据来源

参数

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

返回 

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

返回参数说明

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

3.6关注/取消关注老师

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

说明

关注/取消关注老师

缓存时间

0分钟

提交方式

POST

是否登录

是

数据来源

参数

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

返回 

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

返回参数说明

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

3.7点赞

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

说明

点赞

缓存时间

0分钟

提交方式

POST

是否登录

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

数据来源

参数

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

返回 

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

返回参数说明

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

3.8课后答疑(wap)

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

说明

课后答疑列表

缓存时间

0分钟

是否登录

否

提交方式

GET

数据来源

后台

参数

参数名 参数含义 类型 默认值 是否必须
courseId课程IDString""是
pageNo页数int1是
pageSize页面大小int10是

返回 

{
    "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": "语音地址",
            "publicNumber": "公众号"
        }
    ]
}

返回参数说明

参数名 参数含义 参数名参数含意
type 1:问答小助手,2:用户 publicNumber 公众号


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

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

说明

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

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

缓存时间

0分钟

提交方式

GET

是否登录

否

数据来源

后台

参数

参数名 参数含义 类型 默认值 是否必须
pageNo页数int1是
pageSize页面大小int10是
tagId标签Idint10是

返回 

{
    "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.do
线上环境： http://modern.pclady.com.cn/app/createReward.do

说明

创建打赏订单

缓存时间

0

提交方式

POST

是否需要登录

是

数据来源

整形库编辑后台

参数

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

返回 

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

3.11支付结果提交

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

说明

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

缓存时间

0

提交方式

POST

是否需要登录

是

数据来源

整形库编辑后台

参数

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

返回 

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

3.12报名

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

说明

报名，用于创建订单

缓存时间

0

提交方式

POST

是否需要登录

是

数据来源

整形库编辑后台

参数

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

返回 

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

3.13获取打赏信息

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

说明

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

缓存时间

60分钟

提交方式

GET

是否登录

否

数据来源

后台

参数

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

返回 

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

返回参数说明

3.14取消用户订单

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

说明

取消订单

缓存时间

0

提交方式

GET

是否需要登录

是

数据来源

整形库编辑后台

参数

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

返回 

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

3.15商品(wap)

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

说明

缓存时间

0分钟

提交方式

GET

是否登录

否

数据来源

后台

参数

参数名 参数含义 类型 默认值 是否必须
pageNo页数int1是
pageSize页面大小int10是
courseId课程IDint10是

返回 

{
    "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.do
线上环境： http://modern.pclady.com.cn/app/findList.do
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/findList.do

说明

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

缓存时间

15分钟

提交方式

GET

是否登录

否

数据来源

后台

参数

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

返回 

{
    "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.do
线上环境： http://modern.pclady.com.cn/app/videoCourseInfo.do
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/videoCourseInfo.do

说明

视频课终端页

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

参数名 参数含义 类型 默认值 是否必须
courseId课程IDString""是
inReview= 1：审核状态 0：发布状态int 0 否 ios审核时用到

返回 

{
    "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.老师/达人

4.1获取老师表

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

说明

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

缓存时间

15分钟

提交方式

GET

是否登录

否

数据来源

后台

参数

参数名 参数含义 类型 默认值 是否必须
pageNo页数int1是
pageSize页面大小int10是
techLevelId老师等级ID，0表示全部int0否

返回 

{
    "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",
                        "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.do
线上环境： http://modern.pclady.com.cn/app/techInfo.do
mrobot地址： http://mrobot.pclady.com.cn/x/app/techInfo.do

说明

直播课和预告终端页

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

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

返回 

{
    "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
            }
        ],
        "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.do
线上环境： http://modern.pclady.com.cn/app/getUserInfo.do
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/getUserInfo.do

说明

获取用户信息

缓存时间

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.do
线上环境： http://modern.pclady.com.cn/app/myLiveList.do
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/myLiveList.do

说明


缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

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

返回 

{
    "status": 0,
    "msg": "请求成功",
    "pageNo": 1,
    "pageSize": 20,
    "total": 100,
    "data": [{
                "liveId":1111
                "imageUrl":"图片地址",
                "state":1,//0:未开始,1:进行中,2:已结束
                "title":"标题",
                "learnTotal":100,//报名人数
                "time":MM.dd HH:mm,//开始时间,
                "timeCount":120//计时器，少于24小时返回，单位：秒
    }]
}

返回参数说明

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


5.3我的课程列表

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

说明

查询我的课程列表

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

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

返回 

{
    "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.do
线上环境： http://modern.pclady.com.cn/app/myRewardList.do
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/myRewardList.do

说明

查询我的资产

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

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

返回 

{
    "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 赏金 techIdtechId和techNickName类型为支出才需要返回
userId userId和userNickName类型为收入才需要返回 payTime支付时间
orderId 流水号，类型为支出需要返回 rewardId资产ID


5.5提现记录

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

说明

查询我的订单

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

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

返回 

{
    "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.do
线上环境： http://modern.pclady.com.cn/app/courseCollectionList.do
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/courseCollectionList.do

说明

课程收藏

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

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

返回 

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

返回参数说明

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


5.7关注列表

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

说明

老师关注列表

缓存时间

0分钟

是否登录

是

提交方式

GET

数据来源

后台

参数

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

返回 

{
    "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修改用户资料

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

说明

修改用户资料

缓存时间

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.do
线上环境： http://modern.pclady.com.cn/app/enterRoom.do
mrobot地址： http://mrobot.pclady.com.cn/x/modern/app/enterRoom.do

说明

进入直播室

缓存时间

0分钟

是否登录

是

提交方式

POST

数据来源

后台

参数

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

返回 

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

返回参数说明

6.2离开课程直播

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

说明

离开直播室

缓存时间

0分钟

是否登录

是

提交方式

POST

数据来源

后台

参数

参数名 参数含义 类型 默认值 是否必须
courseId 课程号 String "" 是
isEnd 是否结束，老师需要带这个参数 String "" 否
fileId 文件ID，用于查询录播文件 String "" 是

返回 

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

返回参数说明

6.3开始直播

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

说明

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

缓存时间

0分钟

是否登录

是

提交方式

POST

数据来源

后台

参数

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

返回 

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

返回参数说明

7.其它

7.1关于我们(wap，制作)

7.2帮助中心(wap，制作)

Attachments