钉课堂接口文档

api dkt

更新历史

目录

1. 课堂

1.1 创建课堂

接口地址

/api/course/add

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequesTBody
creator_uid	是	String	用户ID
title	否	String	课堂名称，默认使用当前时间

HTTP 响应状态

200

data

接口示例

Request
curl -X POST -d {"creator_uid":"xxxxx"} http://ip:port/api/course/add
Response
{"data":{"course_id":"d63efdd4-fb48-427f-a09a-fe25444e4f92","create_time":"2018-12-13 16:46:05","creator_uid":"testuser","duration":0.0,"id":"5c121c4dbcffe95a7b5c9d25","title":"2018-12-13 16:46:05"},"success":true}

1.2 更新课堂数据

接口地址

/api/course/update

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequesTBody
course_id	是	String	课堂ID
canvas	否	JSONArray	绘画数据
slides	否	JSONArray	ppt数据

HTTP 响应状态

200

接口示例

Request
curl -X POST -d "Content-Type:application/json" -d {"course_id":"d63efdd4-fb48-427f-a09a-fe25444e4f92","canvas":[{"type":"free","sTime":4,"size":10,"color":"red","data":[{"x":"0.01","y":"0.01","t":"s"},{"x":"0.01","y":"0.01","t":"m"}]},{"type":"free","sTime":4,"size":10,"color":"red","data":[{"x":"0.01","y":"0.01","t":"s"},{"x":"0.01","y":"0.01","t":"m"}]}],"slides":[{"id":0,"sTime":1,"data":{"type":"image","url":"http://www.sewise.com/1"}},{"id":0,"sTime":1,"data":{"type":"image","url":"http://www.sewise.com/1"}}]} http://ip:port/api/course/update
Response
{"success":true}

1.3 查询课堂

接口地址

/api/course/query

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
RequesTBody
creator_uid	是	String	创建者ID
create_time	否	String	按时间查询
course_id	否	String	按课程ID查询

HTTP 响应状态

200

接口示例

Request
curl http://ip:port/api/course/query?creator_uid=xxxxx&create_time=2018-12-12
Response
{"data":[{"course_id":"a3b15018-04b3-4eda-a4c6-6d0072378b77","create_time":"2018-12-13 17:02:22","creator_uid":"testuser","duration":0.0,"id":"5c12201ebcffe95bf93df1c4","title":"2018-12-13 17:02:22"}],"success":true}

1.4 删除课堂

接口地址

/api/course/delete

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequesTBody
course_id	是	String	课堂ID

HTTP 响应状态

200

接口示例

Request
curl -X POST -d "Content-Type:application/json" -d {"course_id":"d63efdd4-fb48-427f-a09a-fe25444e4f92"} http://ip:port/api/course/delete
Response
{"success":true}

2 用户

2.1 用户登录

接口地址

/api/user/login

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequesTBody
authCode	是	String	用户免登授权码
corpId	是	String	授权企业的CorpId

HTTP 响应状态

200

data

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"authCode":"xxxx","corpId":"xxxxx"} http://ip:port/api/user/login
Response
{"success":true,"data":{"userId":"xxx"，"corpId":"xxxxx"}}