[关闭]
@sewise-dev 2017-02-10T08:31:23.000000Z 字数 2867 阅读 739

微录播api(分享)

微录播


更新历史

编号 版本 说明 作者 日期
1 v1.0 创建文档 seven 2017-01-16

目录

1. 全局返回码说明

HTTP请求状态返回格式

返回字段 字段类型 说明
success Integer 请求返回码(详细请见状态表)
msg String 返回描述
data json 返回结果

错误样例
{
"success": false,
"mgs": "invalid appid"
}
成功样例
{
"success": true,
"data": {"access_token":"ACCESS_TOKEN","expires_in":7200}
}


1.课程分享

1.1 分享

接口地址

/swl/share

HTTP Content-Type / 请求方式

application/json
POST

请求参数
参数 必选 类型 说明
RequestBody
users string 分享用户id字符串(逗号隔开)
nickname String 分享用户名字符串(逗号隔开)
swlid String 课程swlid
title String 课程名称
image String 截图
video_url String 视频地址
summary String 简介
duration int 时长
userinfo json 分享者用户信息
username 分享者用户名
nickname 分享者昵称
HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回状态码
msg String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"users":1,2,3,"nickname":"name1,name2,name3"} http://localhost/swl/share
Response
{"success":true}

1.2 获取分享课程

接口地址

/swl/getShareList

HTTP Content-Type / 请求方式

application/json
get

请求参数
参数 必选 类型 说明
RequestBody
swlid string 课程swlid
page int 页码
pageSize int 页数
q string 搜索关键词
userinfo json 分享者用户信息
role 用户角色
username 分享者用户名
HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回状态码
msg String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"role":1,"username":"name1","q":"123"} http://localhost/swl/getShareList
Response
{
"success": true,
"data": [
{
"_id": "587c6265df776626d319d386",
"share_id": "baf20e37-d50b-4006-b433-cebc17ae1ef0",
"to_uid": "3",
"to_nickname": "caifei",
"swlid": "222",
"title": "百度课堂",
"image": "http://www.sewise.com/image/1394324.jpg",
"from_uid": "蔡老师",
"from_nickname": "我是的淡蓝色的方式,seven,caifei",
"type": 1,
"video_url": "http://www.baidu.com/sfsfiem/3/sdfsds.mp4",
"summary": "简介12312",
"spend_time": 0,
"studyprocess": 0,
"duration": "500",
"spendtime_total": 0,
"finish_time": 0,
"answer_ids": 0,
"question_total": 0,
"wrong_total": 0,
"right_total": 0,
"klg_ids": null,
"klg_total": 0,
"know_well_total": 0,
"create_time": "2017-01-16 14:43:37"
},
],
"pages": 1
}

1.3 获取分享课程的老师列表

接口地址

/swl/share/fromList

HTTP Content-Type / 请求方式

application/json
get

请求参数
参数 必选 类型 说明
RequestBody
userinfo json 分享者用户信息
username 分享者用户名
nickname 分享者昵称
HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回状态码
msg String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"role":1,"username":"name1","q":"123"} http://localhost/swl/share/fromList
Response
{
"success": true,
"data": [
{
"username": "蔡老师",
"nickname": "我是的淡蓝色的方式,seven,caifei"
}
],
}

1.4 获取单个分享课程

接口地址

/swl/share/{share_id}

HTTP Content-Type / 请求方式

application/json
get

请求参数
参数 必选 类型 说明
RequestBody
share_id string 分享id
userinfo json 分享者用户信息
username 分享者用户名
nickname 分享者昵称
HTTP 响应状态

200

返回字段 字段类型 说明
success int 返回状态码
msg String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"role":1,"username":"name1"} http://localhost/swl/share/2348sdf-23423423
Response
{
"success": true,
"data": [
{
"share_id": "2348sdf-23423423",
...
}
],
}

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注