wiki:pclady_modern1.0.0_api

Version 4 (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:”请求成功”
}

返回参数说明

参数名 参数含义
status 0:成功,-1:用户被禁用,-2:其它失败原因

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

说明

根据需求文档返回对应的节点
由于需要查询正在直播的视频,先不考虑缓存

缓存时间

0

提交方式

GET

是否登录

数据来源

摩登后台

参数

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

返回

{
    "status": 0,
    "msg": "请求成功",
    "focus": [
        {
            "typeName": "焦点图类型",
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "url": "外链url",
            "contentId": "14324"
        }
    ],
    "recommend": [
        {
            "contentId": 1111,
            "typeName": "推荐类型,类型同焦点图",
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "url": "外链url",
            "recommendId": "14324",
            "title": "标题",
            "desc": "推荐描述"
        }
    ],
    "liveVideo": [
        {
            "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",
            "watchTotal": 100
        }
    ],
    "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": "标签"
            }
        ]
        }
    ],
    "hotVideo": [
        {
            "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,一对一课程:lesson,老师:teach,标签:tagInfo,外接:webview focus 焦点图节点,返回5张焦点图
recommend 推荐节点,返回三条 liveVideo 直播视频节点,3条
liveType 1:直播,2:预告 imageUrl liveVideo节点中为封面图
techID 老师ID techJobName 头衔
startTime 如果为预告,要返回开始时间 watchTotal 如果是直播,返回观看人数
techIconUrl 老师等级icon techType 老师类型,1:老师,2:达人
teacher 老师推荐节点,7条 chosenVideo 精选直播课节点,3条
liveTime 视频时长 tag 标签,最多三个
hotVideo 热点视频节点,6个 tag 标签,最多三个



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页数int1
pageSize页面大小int10

返回

{
    "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.2直播课终端页

开发环境: 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课程IDString""

返回

{
    "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": "课程描述",
        "courseList": [
            {
                "courseId": 11,
                "liveType": 1,
                "liveTime": "6'33''",
                "startTime": "MM.dd hh:mm",
                "imageUrl": "http://img.pconline.com.cn/7.jpg",
                "title": "课程标题"
            }
        ],
        "watchIng": [
            "11",
            "222"
        ]
    }
}

返回参数说明

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


3.3直播课终端页问答列表

开发环境: 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课程IDString""
pageNo页数int1
pageSize页面大小int10

返回

{
    "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,
            "replyList": [
                {
                    "replyId": 11,
                    "message": "回复内容",
                    "createTime": "MM-dd hh:mm",
                    "nickName": "昵称",
                    "userId": 111
                }
            ]
        }
    ]
}

返回参数说明

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


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 "" 回复内容
requestID 回复ID 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

是否登录

数据来源

参数

参数名 参数含义 类型 默认值 是否必须
courseIdID,批量取消收藏时,用英文逗号隔开 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

是否登录

数据来源

参数

参数名 参数含义 类型 默认值 是否必须
techIdID,批量取消关注时,用英文逗号隔开 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

是否登录

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

数据来源

参数

参数名 参数含义 类型 默认值 是否必须
courseIdID String ""
requestId如果是问答,需要传此参数 String ""

返回

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

返回参数说明

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

3.8课后答疑

开发环境: 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课程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": "语音地址",
            "voiceState": 1,
            "voiceLength": 10,
            "publicNumber": "公众号"
        }
    ]
}

返回参数说明

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


3.9评论发送(评论系统)

经评论系统
url: http://cmt.pcauto.com.cn/action/comment/create_utf8.jsp

说明

评论列表页中发表评论

缓存时间

0分钟

提交方式

POST

是否登录

数据来源

参数

参数名 参数含义 类型 默认值 是否必须 说明
id 话题id string ""
url 话题url string ""
username 用户名 string ""
anonymous 是否匿名 string "" anonymous:匿名,1为匿名(可选参数)
content 回复内容 string "" 回复内容
common_session_id 太平洋通行证session string "" cookies中添加

返回

{
    "commentId":25705754,
    "floor":27,
    "showName":"iostester",
    "brief":"Really good car hm~~~",
    "status":0,
    "createTime":"2013-07-19 10:37:03",
    "resultCode":0,
    "resultMsg":"您的评论已经成功发表。注:评论在审核后才能出现在列表中,谢谢!",
    "userId":25520497
}

返回参数说明

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

3.10文章评论列表 (WEB)

后端接口地址: http://cmt.pclady.com.cn/action/comment/list_new_json.jsp?url=http://pclady.com.cn/pcladynews/article/197.html&pageNo=1&pageSize=5&reverse=0

mrobot地址: http://mrobot.pclady.com.cn/s/modern/cms/comments.xsp?url=http://pclady.com.cn/pcladynews/article/197.html&pageNo=1&pageSize=5&reverse=0

说明

获取文章评论列表

缓存时间

提交方式

GET

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
url 文章url string "" 文章url
pageNo 第几页 int 1 第几页
pageSize 每页显示的条数 int 20 每页显示的条数
reverse 排序方式 int 0 0 倒序; 1 正序

返回

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

开发环境: 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页数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.12打赏

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

说明

创建打赏订单

缓存时间

0

提交方式

POST

是否需要登录

数据来源

整形库编辑后台

参数

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

返回

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

3.13支付结果提交

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

说明

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

缓存时间

0

提交方式

POST

是否需要登录

数据来源

整形库编辑后台

参数

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

返回

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

3.14报名

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

说明

报名,用于创建订单

缓存时间

0

提交方式

POST

是否需要登录

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
courseId课程idString""
userName称呼 int ""
phoneNum手机号码String""
remind是否短信提醒,1:提醒,0:不提醒String""
r时间截String""
signMD5加密串String""

返回

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

3.15创建微信订单

开发环境: http://dev15.pclady.com.cn/app/createWechatOrder.jsp
线上环境: http://plastic.pclady.com.cn/app/createWechatOrder.jsp

说明

生成微信订单

缓存时间

0

提交方式

POST

是否需要登录

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
orderNO 流水号IDString""
r时间截String""
signMD5加密串String""

返回

{
    "status": 0,
    "msg": "请求成功",
    "timestamp": "时间戳",
    "appid": "应用ID",
    "partnerid": "商户ID",
    "prepayid": "预支付订单",
    "noncestr": "随机串",
    "package": "商家根据财付通文档填写的数据和签名",
    "sign": "签名"
}

4.一对一

4.1获取一对一教程列表

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

说明

获取一对一教程列表,默认加载10条

由于考虑到价钱有变,先不考虑缓存

缓存时间

0分钟

提交方式

GET

是否登录

数据来源

后台

参数

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

返回

{
    "status": 0,
    "msg": "请求成功",
    "pageNo": 1,
    "pageSize": 20,
    "total": 100,
    "data": [
        {
            "courseId": 11,
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "price": 1111,
            "gradeImageUrl": "http://img.pconline.com.cn/7.jpg",
            "title": "课程标题",
            "desc":"描述",
            "buyTotal",100
        ]
        }
    ]
}

返回参数说明

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


Attachments