[关闭]
@sewise-dev 2018-06-15T07:30:12.000000Z 字数 23764 阅读 551

对接api文档

平台对接 知识元


商户SDK中间件知识元系统1.注册(appid+secret+uid)2.检验3.数据不正确4.调用注册API5.生成用户信息6.返回授权信息7.返回信息(access_token、expire)8.授权码调起SDK9.获取用户信息10.验证鉴权11.失败,返回错误信息12.失败,返回错误信息13.成功,返回用户信息14.初始化success,允许调用15.业务处理16.数据交互、内容上传17.返回结果18.结果回调商户SDK中间件知识元系统用户注册时序图

1.用户中心

1.1 获取单用户授权access_tokne(单用户)

接口地址

/v1/user/getToken

HTTP Content-Type / 请求方式

application/json
get

请求参数
参数 必选 类型 说明
RequestBody
appid String 第三方用户唯一凭证
secret String 第三方用户唯一凭证密钥,即appsecret
uid string 第三方平台的用户uid
HTTP 响应状态

200

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

Request
curl -X get -H "Content-Type:application/json" -d http://v.sewise.com/v1/user/getToken?appid={APPID}&secret={SECRET}&uid={UID}

HTTP 响应状态

200

返回字段 字段类型 说明
status int 状态码
data array 当前提交的内容

返回示例
{"status":200,"data":{"access_token":"qO9Bj6pqk0Ma7jh9hcBBOH1QcBb6467XC8YwJTcW","expire":"2018-06-15 11:45:36"}}

1.2 跳转web端

接口地址

/weike?access_token={access_token}

HTTP Content-Type / 请求方式

application/json
get

请求参数
参数 必选 类型 说明
RequestBody
access_token string 用户鉴权签证
HTTP 响应状态

200

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

Request
curl -X get -H "Content-Type:application/json" -d http://v.sewise.com/weike?access_token=QVlBvVaijyRW2cRDVyF823zQoD8nXAV5QnBaK75O

2.录课

2.1 课程列表

接口地址

/course/all

HTTP Content-Type / 请求方式

application/json
GET

请求参数

RequestBody

参数 必选 类型 说明
RequestBody
access_token string 用户鉴权签证
size int 页码
page int 页数
title string 搜索标题
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Array 返回结果
接口示例

Request
curl -X GET -H "Content-Type:application/json" -d http://v.sewise.com/course/all?access_token=xxxxxx

2.2.1 该课程所有课时列表

接口地址

/course/allChapter

HTTP Content-Type / 请求方式

application/json
GET

请求参数

RequestBody

参数 必选 类型 说明
RequestBody
access_token string 用户鉴权签证
courseid string 课程id
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Array 返回结果
接口示例

Request
curl -X GET -H "Content-Type:application/json" -d http://v.sewise.com/course/allChapter?courseid=xxxxx&access_token=xxxxxx
Response
{"success":true,"data":[{"swlid":"95d78585-3314-4ad7-b44d-000bf133faec","creator_uid":"admin","creator_nickname":"管理员","title":"简介简介","duration":599.099,"image":"/video/photo/?path=storage/swlsource/video/39/f4c03753.mp4","is_open_topic":1,"video_url":"","poster":"","summary":"","require":"","create_time":"2017-02-08 16:39:54","knowledge":[{"klgid":"d5484376-85e4-4ed7-9434-b1ee92dd1fc1","title":"2","element_title":"","duration":23,"start_time":0,"end_time":23,"creator_uid":"admin","creator_nickname":"管理员","swpid":"918d03cf-3284-4da1-84ae-651529906173","swptitle":"","video_url":"storage/swlsource/video/39/f4c03753.mp4","video_name":"98888.mp4","assist_id":"","assist_url":"storage/swlsource/pdf/5b/3686c2f8.pdf","assist_name":"3686c2f8.pdf","create_time":"2017-02-08 16:39:09","image":"storage/swlsource/pdf/5b/3686c2f8/1.png","hide":"","quote_count":"","topic_ids":"","knowledge_element":[{"elgid":"6d7ab477-a543-4f6b-a179-76918bead5cc","title":"2","creator_uid":"admin","creator_nickname":"管理员","pdf_url":"","pdf_json":{"id":0,"page":1,"sTime":0,"title":"2","type":"1","eTime":23,"duration":23},"vtt_json":[],"topic_json":[],"timeline_json":"","event_timeline_json":"","duration":23,"start_time":0,"end_time":23,"create_time":"2017-02-08 16:39:09"],"_id":148}],"question_total":0,"klg_total":9,"_id":11}]}]}

2.2.2 云空间课时列表

接口地址

/swl/cloudChapter

HTTP Content-Type / 请求方式

application/json
GET

请求参数

RequestBody

参数 必选 类型 说明
RequestBody
access_token string 用户鉴权签证
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Array 返回结果
接口示例

Request
curl -X GET -H "Content-Type:application/json" -d http://v.sewise.com/swl/cloudChapter?access_token=xxxxxx
Response
{"success":true,"data":[{"swlid":"95d78585-3314-4ad7-b44d-000bf133faec","creator_uid":"admin","creator_nickname":"管理员","title":"简介简介","duration":599.099,"image":"/video/photo/?path=storage/swlsource/video/39/f4c03753.mp4","is_open_topic":1,"video_url":"","poster":"","summary":"","require":"","create_time":"2017-02-08 16:39:54","knowledge":[{"klgid":"d5484376-85e4-4ed7-9434-b1ee92dd1fc1","title":"2","element_title":"","duration":23,"start_time":0,"end_time":23,"creator_uid":"admin","creator_nickname":"管理员","swpid":"918d03cf-3284-4da1-84ae-651529906173","swptitle":"","video_url":"storage/swlsource/video/39/f4c03753.mp4","video_name":"98888.mp4","assist_id":"","assist_url":"storage/swlsource/pdf/5b/3686c2f8.pdf","assist_name":"3686c2f8.pdf","create_time":"2017-02-08 16:39:09","image":"storage/swlsource/pdf/5b/3686c2f8/1.png","hide":"","quote_count":"","topic_ids":"","knowledge_element":[{"elgid":"6d7ab477-a543-4f6b-a179-76918bead5cc","title":"2","creator_uid":"admin","creator_nickname":"管理员","pdf_url":"","pdf_json":{"id":0,"page":1,"sTime":0,"title":"2","type":"1","eTime":23,"duration":23},"vtt_json":[],"topic_json":[],"timeline_json":"","event_timeline_json":"","duration":23,"start_time":0,"end_time":23,"create_time":"2017-02-08 16:39:09"],"_id":148}],"question_total":0,"klg_total":9,"_id":11}]}]}

2.3 知识点列表

接口地址

/knowledge/all

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestBody
page string 页数,默认为1
size string 一页显示数量,默认为15
stime string 创建开始时间,默认为空
etime string 创建结束时间,默认为空
title string 题目,默认为空
teacher string 创建者id,默认为空
access_token string 用户鉴权签证
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Array 返回结果
pages Integer 返回总页数
接口示例

Request
curl -X get -H "Content-Type:application/json" -d
http://v.sewise.com/knowledge/all?access_token=xxxx
Response
{"success":true,"data":[{"klgid":"b6c2d703-4046-478a-a9da-330e7f6af144","title":"","element_title":"","duration":101,"start_time":172,"end_time":273,"creator_uid":"admin","creator_nickname":"管理员","swpid":"918d03cf-3284-4da1-84ae-651529906173","swptitle":"","video_url":"storage/swlsource/video/39/f4c03753.mp4","video_name":"98888.mp4","assist_id":"","assist_url":"storage/swlsource/pdf/5b/3686c2f8.pdf","assist_name":"3686c2f8.pdf","create_time":"2017-02-08 16:39:09","image":"storage/swlsource/pdf/5b/3686c2f8/4.png","hide":"","quote_count":"","topic_ids":"","knowledge_element":[{"elgid":"1a634112-915f-406d-ba9e-2d6243888e96","title":"","creator_uid":"admin","creator_nickname":"管理员","pdf_url":"","pdf_json":{"page":4,"sTime":172,"eTime":273,"id":3,"type":"1","title":"","duration":101},"vtt_json":[],"topic_json":[],"timeline_json":"","event_timeline_json":"","duration":101,"start_time":172,"end_time":273,"create_time":"2017-02-08 16:39:09"}]}],"pages":1}

2.4 公开课列表

接口地址

/course/allCloud

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestBody
page string 页数,默认为1
size string 一页显示数量,默认为15
stime string 创建开始时间,默认为空
etime string 创建结束时间,默认为空
title string 题目,默认为空
grade string 年级,默认为空
subject string 学科,默认为空
order string 按时间/标题排序,默认为按时间
access_token string 用户鉴权签证
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Array 返回结果
接口示例

Request
curl -X get -H "Content-Type:application/json" -d
http://v.sewise.com/course/allCloud?access_token=xxxx

Response
{"success":true,"data":[]}

2.5 生成APP录课二维码

接口地址

/weike/qrcode/{access_token}

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestBody
access_token string 用户鉴权签证
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Array 返回结果
pages Integer 返回总页数
接口示例

Request
curl -X get -H "Content-Type:application/json" -d
http://v.sewise.com/weike/qrcode?access_token=xxxx

2.6 删除课时

接口地址

/course/swl/{courseid}/{swlid}?access_token={access_token}

HTTP Content-Type / 请求方式

application/json
delete

请求参数
参数 必选 类型 说明
RequestBody
courseid string 课程id
swlid string 课时id
access_token string 用户鉴权签证
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Array 返回结果
pages Integer 返回总页数
接口示例

Request
{"success":true,"swlid":"19d31f15-1c6e-43ea-9039-70363b610561"}

3.播放

3.1 微课信息

接口地址

/swl/{swlid}?access_token={access_token}

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestPath
swlid string 知识点课id
access_token string 用户鉴权签证
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Json 返回结果
接口示例

Request
curl -X GET -H "Content-Type:application/json" http://v.sewise.com/swl/{swlid}?access_token={access_token}
Response
{"success":true,"data":{"page":3,"sTime":3,"id":2,"title":"阿萨德群","duration":2,"swpid":"pakit_8","_id":7609,"swpinfo":{"id":8,"name":"pa221.mp4","fullname":"storage/public/lubocam/pakit/pa221.mp4","type":"video","size":34657748,"time":1482990012,"phototime":134,"encrypt":0,"zip":1,"start_time":"0000-00-00 00:00:00","end_time":null,"duration":134,"camname":null,"sf1":null,"sf2":null,"sf3":null,"userid":"pakit","nickname":"pakit","swpid":"pakit_8","introduction":"","questionsnum":1,"knowlegenum":3,"_id":63}},{"page":2,"sTime":2,"id":1,"duration":2,"swpid":"pakit_10","_id":7668,"swpinfo":{"id":10,"name":"pa23.mp4","fullname":"storage/public/lubocam/pakit/pa23.mp4","type":"video","size":34657680,"time":1482990066,"phototime":134,"encrypt":0,"zip":1,"start_time":"0000-00-00 00:00:00","end_time":null,"duration":134,"camname":null,"sf1":null,"sf2":null,"sf3":null,"userid":"pakit","nickname":"pakit","swpid":"pakit_10","introduction":"","questionsnum":2,"knowlegenum":2,"_id":64}}}

3.2 播放器播放

接口地址

/swl/m3u8

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestPath
swlid string 知识点课id
access_token string 用户鉴权签证
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
path String 播放地址
接口示例

Request
curl -X GET -H "Content-Type:application/json" http://v.sewise.com/swl/m3u8
Response
{"success":true,"path":"http://sp05av100033108a.nrp.sewise.com.cn/storage/swlsource/m3u8/preview/1499674999620_29DA.m3u8"}

3.3 发布云空间

接口地址

/course/toCloud

HTTP Content-Type / 请求方式

application/json
post

请求参数
参数 必选 类型 说明
RequestPath
courseArr 数组 课程id的集合
access_token string 用户鉴权签证
HTTP 响应状态

200
Response
{"success":true,"msg":""}

3.4 删除云空间课程

接口地址

/course/cloudDelete/:courseid

HTTP Content-Type / 请求方式

application/json
delete

请求参数
参数 必选 类型 说明
RequestPath
courseid string 课程的id,多个用逗号隔开
access_token string 用户鉴权签证
HTTP 响应状态

200
Response
{"success":true,"msg":""}

4.学生端

4.1 获取教师列表

接口地址

/swl/share/fromList

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestBody
access_token string 用户鉴权签证
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Array 返回结果

data信息解析

返回字段 字段类型 说明
username string 教师的username
nickname string 教师的昵称

请求接口用的都是username,nickname没有用到,nickname只是用来前端展示,一般是中文

接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"access_token":"xxxxxx"} http://v.sewise.com/swl/share/fromList?access_token=xxxx
Response
{"success":true,"data":[{"username":"admin","nickname":"管理员"},{"username":"pakit","nickname":"pakit"},{"username":"teacher2","nickname":"老师2号"},{"username":"kakaxi","nickname":"卡卡西"},{"username":"50","nickname":"吴老师"},{"username":"60","nickname":"严老师"},{"username":"70","nickname":"赵老师"},{"username":"yuwenlaoshi","nickname":"语文老师"}]}

4.2 我的微课

接口地址

/swl/all

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestBody
page string 页数,默认为1
size string 一页显示数量,默认为15
stime string 创建开始时间,默认为空
etime string 创建结束时间,默认为空
title string 题目,默认为空
teacher string 创建者id,默认为空
access_token string 用户鉴权签证
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Array 返回结果
pages Integer 返回总页数
接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"access_token":"xxxxx","q":"k"} http://v.sewise.com/swl/all?{access_token}
Response
{"success":true,"data":[{"swlid":"95d78585-3314-4ad7-b44d-000bf133faec","creator_uid":"admin","creator_nickname":"管理员","title":"简介简介","duration":599.099,"image":"/video/photo/?path=storage/swlsource/video/39/f4c03753.mp4","is_open_topic":1,"video_url":"","poster":"","summary":"","require":"","create_time":"2017-02-08 16:39:54","knowledge":[{"klgid":"d5484376-85e4-4ed7-9434-b1ee92dd1fc1","title":"2","element_title":"","duration":23,"start_time":0,"end_time":23,"creator_uid":"admin","creator_nickname":"管理员","swpid":"918d03cf-3284-4da1-84ae-651529906173","swptitle":"","video_url":"storage/swlsource/video/39/f4c03753.mp4","video_name":"98888.mp4","assist_id":"","assist_url":"storage/swlsource/pdf/5b/3686c2f8.pdf","assist_name":"3686c2f8.pdf","create_time":"2017-02-08 16:39:09","image":"storage/swlsource/pdf/5b/3686c2f8/1.png","hide":"","quote_count":"","topic_ids":"","knowledge_element":[{"elgid":"6d7ab477-a543-4f6b-a179-76918bead5cc","title":"2","creator_uid":"admin","creator_nickname":"管理员","pdf_url":"","pdf_json":{"id":0,"page":1,"sTime":0,"title":"2","type":"1","eTime":23,"duration":23},"vtt_json":[],"topic_json":[],"timeline_json":"","event_timeline_json":"","duration":23,"start_time":0,"end_time":23,"create_time":"2017-02-08 16:39:09"],"_id":148}],"question_total":0,"klg_total":9,"_id":11}]}],"pages":1}

4.3 知识点

接口地址

/knowledge/all

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestBody
page string 页数,默认为1
size string 一页显示数量,默认为15
stime string 创建开始时间,默认为空
etime string 创建结束时间,默认为空
title string 题目,默认为空
teacher string 创建者id,默认为空
access_token string 用户鉴权签证
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Array 返回结果
pages Integer 返回总页数
接口示例

Request
curl -X GET -H "Content-Type:application/json" -d {"access_token":"xxxx","q":"zhisdhain"} http://v.sewise.com/knowledge/all?access_token={access_token}
Response
{"success":true,"data":[{"klgid":"b6c2d703-4046-478a-a9da-330e7f6af144","title":"","element_title":"","duration":101,"start_time":172,"end_time":273,"creator_uid":"admin","creator_nickname":"管理员","swpid":"918d03cf-3284-4da1-84ae-651529906173","swptitle":"","video_url":"storage/swlsource/video/39/f4c03753.mp4","video_name":"98888.mp4","assist_id":"","assist_url":"storage/swlsource/pdf/5b/3686c2f8.pdf","assist_name":"3686c2f8.pdf","create_time":"2017-02-08 16:39:09","image":"storage/swlsource/pdf/5b/3686c2f8/4.png","hide":"","quote_count":"","topic_ids":"","knowledge_element":[{"elgid":"1a634112-915f-406d-ba9e-2d6243888e96","title":"","creator_uid":"admin","creator_nickname":"管理员","pdf_url":"","pdf_json":{"page":4,"sTime":172,"eTime":273,"id":3,"type":"1","title":"","duration":101},"vtt_json":[],"topic_json":[],"timeline_json":"","event_timeline_json":"","duration":101,"start_time":172,"end_time":273,"create_time":"2017-02-08 16:39:09"}]}],"pages":1}

4.4 我的错题

接口地址

/statistics/student/wrong

HTTP Content-Type / 请求方式

application/json
get

请求参数
参数 必选 类型 说明
RequestBody
access_token string 用户鉴权签证
swlid string 课件id
teacher_id string 老师id,用于需要根据老师id查询时
time string 时间id,用于需要根据老师id查询时
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
data Array 返回结果

data信息解析

返回字段 字段类型 说明
answer_id string 问题id
creator_uid string 学生id
teacher_id string 老师id
swlid string 课件id
klgid string 知识点id
topic_id string 问题id
question string 问题标题
create_time string 答题时间
round string 答题轮次
option Array 问题选项
answer Array 用户回答id
right_answer Array 正确答案id
is_right string 是否答对
接口示例

Request
curl -X get -H "Content-Type:application/json" -d {"access_token":"xxx","q":"问题"} http://v.sewise.com/statistics/student/wrong?{access_token}
Response
{"status":200,"data":[{"creator_uid":"5112","klgid":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","swlid":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","topic_id":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","question":"nodejs底层使用什么语言实现的?","option":["javascript","c","java","go"],"answer":"2","right_answer":"1","is_right":"0","create_time":"2017-01-16 10:37:39"},{"creator_uid":"5112","klgid":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","swlid":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","topic_id":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","question":"nodejs底层使用什么语言实现的?","option":["javascript","c","java","go"],"answer":"2","right_answer":"1","is_right":"0","create_time":"2017-01-16 10:37:42"},{"creator_uid":"5112","klgid":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","swlid":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","topic_id":"e4f25901-d7e1-11e6-b8a7-b720db0f6d97","question":"nodejs底层使用什么语言实现的?","option":["javascript","c","java","go"],"answer":"2","right_answer":"1","is_right":"0","create_time":"2017-01-16 10:37:43"}]}

4.5 我的错题关联知识点功能

4.5.1 我的错题关联的知识点(单个微课)

接口地址

/statistics/student/wrongkonwledge

HTTP Content-Type / 请求方式

application/json
get

请求参数
参数 必选 类型 说明
access_token string 用户鉴权签证
swlid string 课程id
klgid string 问题关联的知识点id
HTTP 响应状态

200

返回字段 字段类型 说明
result int 返回状态码

result

返回字段 字段类型 说明
title json 知识点名称
video_url json 视频路径
image json 截图
duration json 时长
swptitle json 课程名称
creator_nickname json 讲师
接口示例

Request
curl -X get -H "Content-Type:application/json" http://v.sewise.com/statistics/student/wrongkonwledge/:swlid/:klgid
Response
{"result":[{"klgid":"58059f12-e8a1-4f9e-94fe-7d99714e683d","title":"默认标题","element_title":"","duration":8,"start_time":0,"end_time":8,"creator_uid":"lilaoshi020701","creator_nickname":"李老师020701-修改信息","swpid":"85db4bd5-30f1-4070-9409-4279bf88c648","swptitle":"","video_url":"storage/swlsource/video/19/b42fb269.mp4","video_name":"黄老师课程-三合一.mp4","assist_id":"","assist_url":"storage/swlsource/pdf/26/3e9c1005.pdf","assist_name":"3e9c1005.pdf","create_time":"2035-12-23 05:41:11","image":"storage/swlsource/pdf/26/3e9c1005/1.png","hide":"","quote_count":"","topic_ids":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","knowledge_element":[{"elgid":"9c348f41-a791-4497-bcb6-813b32b46e36","title":"默认标题","creator_uid":"lilaoshi020701","creator_nickname":"李老师020701-修改信息","pdf_url":"","pdf_json":{"id":0,"page":1,"sTime":0,"title":"默认标题","type":"1","eTime":8,"duration":8},"vtt_json":[{"sTime":4,"eTime":6,"content":"范德萨范德萨发大厦的地方"}],"topic_json":[{"creator_uid":"admin","type":"multiple","question":"黄老师课程-三合一的问答,PPT01","option":["D","D","C","D"],"answer":[{"content":"D","rightAnswer":"true"},{"content":"D","rightAnswer":"true"},{"content":"C","rightAnswer":"false"},{"content":"D","rightAnswer":"true"}],"create_time":"2035-12-23 04:54:07","topic_id":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","_id":136,"id":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","uuid":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","question_id":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","showTime":8,"pdfDataID":1,"page":2,"rightJumpTime":8,"errorJumpTime":0,"answerindex":[0,1,3]}],"timeline_json":"","event_timeline_json":"","duration":8,"start_time":0,"end_time":8,"create_time":"2035-12-23 05:41:11","klgid":"58059f12-e8a1-4f9e-94fe-7d99714e683d","swpid":"85db4bd5-30f1-4070-9409-4279bf88c648"}],"_id":2289}],"swltitle":"制作微课删除了知识点"}

4.5.2 我的错题关联的知识点(全部微课)

接口地址

/statistics/student/allwrongkonwledge

HTTP Content-Type / 请求方式

application/json
get

请求参数
参数 必选 类型 说明
access_token string 用户鉴权签证
swlid string 课程id
topic_id string 问题id
HTTP 响应状态

200

返回字段 字段类型 说明
result int 返回状态码

result

返回字段 字段类型 说明
title json 知识点名称
video_url json 视频路径
image json 截图
duration json 时长
swptitle json 课程名称
creator_nickname json 讲师
接口示例

Request
curl -X get -H "Content-Type:application/json" http://v.sewise.com/statistics/student/allwrongkonwledge/:swlid/:topic_id
Response
{"result":[{"klgid":"58059f12-e8a1-4f9e-94fe-7d99714e683d","title":"默认标题","element_title":"","duration":8,"start_time":0,"end_time":8,"creator_uid":"lilaoshi020701","creator_nickname":"李老师020701-修改信息","swpid":"85db4bd5-30f1-4070-9409-4279bf88c648","swptitle":"","video_url":"storage/swlsource/video/19/b42fb269.mp4","video_name":"黄老师课程-三合一.mp4","assist_id":"","assist_url":"storage/swlsource/pdf/26/3e9c1005.pdf","assist_name":"3e9c1005.pdf","create_time":"2035-12-23 05:41:11","image":"storage/swlsource/pdf/26/3e9c1005/1.png","hide":"","quote_count":"","topic_ids":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","knowledge_element":[{"elgid":"9c348f41-a791-4497-bcb6-813b32b46e36","title":"默认标题","creator_uid":"lilaoshi020701","creator_nickname":"李老师020701-修改信息","pdf_url":"","pdf_json":{"id":0,"page":1,"sTime":0,"title":"默认标题","type":"1","eTime":8,"duration":8},"vtt_json":[{"sTime":4,"eTime":6,"content":"范德萨范德萨发大厦的地方"}],"topic_json":[{"creator_uid":"admin","type":"multiple","question":"黄老师课程-三合一的问答,PPT01","option":["D","D","C","D"],"answer":[{"content":"D","rightAnswer":"true"},{"content":"D","rightAnswer":"true"},{"content":"C","rightAnswer":"false"},{"content":"D","rightAnswer":"true"}],"create_time":"2035-12-23 04:54:07","topic_id":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","_id":136,"id":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","uuid":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","question_id":"dfb3cd97-5477-4182-b6d3-cdf064e29b3d","showTime":8,"pdfDataID":1,"page":2,"rightJumpTime":8,"errorJumpTime":0,"answerindex":[0,1,3]}],"timeline_json":"","event_timeline_json":"","duration":8,"start_time":0,"end_time":8,"create_time":"2035-12-23 05:41:11","klgid":"58059f12-e8a1-4f9e-94fe-7d99714e683d","swpid":"85db4bd5-30f1-4070-9409-4279bf88c648"}],"_id":2289}],"swltitle":"制作微课删除了知识点"}

4.6 通过swlid获取课程

接口地址

/swl

HTTP Content-Type / 请求方式

application/json
GET

请求参数
参数 必选 类型 说明
RequestPath
access_token string 用户鉴权签证
swlid string 课程id
HTTP 响应状态

200

返回字段 字段类型 说明
success Booleans 返回状态码
data Json 返回结果
接口示例

Request
curl -X GET -H "Content-Type:application/json" http://v.sewise.com/swl/swlid?access_token={access_token}
Response
{"success":true,"data":{"page":3,"sTime":3,"id":2,"title":"阿萨德群","duration":2,"swpid":"pakit_8","_id":7609,"swpinfo":{"id":8,"name":"pa221.mp4","fullname":"storage/public/lubocam/pakit/pa221.mp4","type":"video","size":34657748,"time":1482990012,"phototime":134,"encrypt":0,"zip":1,"start_time":"0000-00-00 00:00:00","end_time":null,"duration":134,"camname":null,"sf1":null,"sf2":null,"sf3":null,"userid":"pakit","nickname":"pakit","swpid":"pakit_8","introduction":"","questionsnum":1,"knowlegenum":3,"_id":63}},{"page":2,"sTime":2,"id":1,"duration":2,"swpid":"pakit_10","_id":7668,"swpinfo":{"id":10,"name":"pa23.mp4","fullname":"storage/public/lubocam/pakit/pa23.mp4","type":"video","size":34657680,"time":1482990066,"phototime":134,"encrypt":0,"zip":1,"start_time":"0000-00-00 00:00:00","end_time":null,"duration":134,"camname":null,"sf1":null,"sf2":null,"sf3":null,"userid":"pakit","nickname":"pakit","swpid":"pakit_10","introduction":"","questionsnum":2,"knowlegenum":2,"_id":64}}}

4.7 撕书功能

4.7.1 保存撕书记录

接口地址

/wipe/add

HTTP Content-Type / 请求方式

application/json
POST

请求参数
参数 必选 类型 说明
RequestBody
access_token string 用户鉴权签证
wipe_id string 唯一识别码uuid,撕书id
create_time string 创建时间
swlid string 课件id
klgid string 知识点id
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 保存结果
error string 错误信息,如错误,返回,否则没有
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"swlid":"123321",klgid:"123321"}
url: http://api.sewise.com/wipe/add
Response
成功:{"result":success}
失败:{"result":failure}

4.7.2 删除撕书记录

接口地址

/wipe/

HTTP Content-Type / 请求方式

application/json
DELETE

请求参数
参数 必选 类型 说明
RequestBody
access_token string 用户鉴权签证
wipe_id string 唯一识别码uuid,撕书id
create_time string 创建时间
swlid string 课件id
klgid string 知识点id
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 删除记录结果
error string 错误信息,如错误,返回,否则没有
接口示例

Request
curl -X DELETE -H "Content-Type:application/json" -d {"swlid":"123321",klgid:"123321"}
url: http://v.sewise.com/wipe/delete
Response
{"success":true}

5.外部播放器API

注意:一个页面只能引用一个播放器,生成新的播放器,应先将原先的播放器容器销毁

5.1 播放器引用方式

通过嵌入html页面的方式渲染播放器

参数

参数 必选 类型 说明
host string 微录播域名
swlid string 微课swlid
uid int 自主平台用户id
access_token string 用户鉴权码access_token
type int 用户类型,默认1为学生,2为老师
callback boolean 是否需要主动发送播放进度
callbackUrl string 主动发送的地址(当callback为true,此参数必须)
playProgress int 设置播放进度(数值范围:1-100),设置此参,播放进度将会从此开始播放

拼写规则

1.生成设置参数

  1. var obj ={
  2. 'host' : 'http://v.sewise.com' ,
  3. 'swlid' : '4593843e-05c1-460e-af30-831920a930ed' ,
  4. 'uname' : 12 ,
  5. 'callback' : true ,
  6. 'callbackUrl' : 'http://v.sewise.com/addplay?userid=12' , //自主平台路径,此处userid是为不同用户保存不同进度
  7. 'playProgress' : 50
  8. }
  9. var playerdata = encodeURI(JSON.stringify(obj));//将参数转成json字符串,再进行encodeURI转码
  10. var playerhtml = '<script id="sewiseswlplayer" src="'+obj.host+'/widgets/libs/sewiseswlplayer.js?data='+playerdata+'" charset="utf-8"></script>';//播放地址

2.代码生成结果示例

  1. <script id="sewiseswlplayer" src="http://v.sewise.com/widgets/libs/sewiseswlplayer.js?data=%7B%22host%22:%22http://v.sewise.com%22,%22swlid%22:%224593843e-05c1-460e-af30-831920a930ed%22,%22uname%22:12,%22callback%22:true,%22callbackUrl%22:%22http://v.sewise.com/addplay?userid=12%22,%22playProgress%22:50%7D"charset="utf-8"></script>

3.将代码放入html页面,即可生成sewise播放器

callbackUrl要求

播放器主动传递的参数

请求方式:post

参数 类型 说明
precent int 百分比(数值范围:1-100)
total_time int 视频总时长(s)
playTime int 当前播放时间(s)

5.2 播放器控制接口

支持的接口

  • pause 暂停
  • play 播放
  • stop 停止
  • playTime 获取当前视频播放到的位置(秒)

接口使用方式

播放器引用成功后,将会生成一个全局的函数变量:window.getSWLPlayer

示例

  1. //以鼠标移出播放器,播放自动暂停为例
  2. window.getSWLPlayer(function (sw) {
  3. //sw为播放器对象
  4. $(sw.el).on('mouseleave',function(){//表示离开播放器组件
  5. sw.pause();//调用播放器暂停方法
  6. })
  7. })

6. android-sdk

知识元android-sdk-1.jpg-395.6kB
知识元android-sdk-2.jpg-360.5kB
知识元android-sdk-3.jpg-95.8kB

7. ios-sdk

ios知识元sdk-1.jpg-418.4kB
ios知识元sdk-2.jpg-268.2kB

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