3.5 KiB
3.5 KiB
四川智慧教育刷课 API 文档
基础信息
- 基础路径:
/v1/course - 需要认证: 是 (Bearer Token)
- Content-Type:
application/json
1. 查询课程列表
登录四川智慧教育平台,获取用户的课程列表。
请求
POST /v1/course/smartedu-sc/query
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| username | string | 是 | 登录账号 |
| password | string | 是 | 登录密码 |
请求示例
{
"username": "13800138000",
"password": "your_password"
}
响应示例
{
"code": 200,
"msg": "success",
"data": [
{
"id": "course_id_1",
"courseName": "课程名称1",
"image": "https://xxx.com/image.jpg"
},
{
"id": "course_id_2",
"courseName": "课程名称2",
"image": "https://xxx.com/image2.jpg"
}
]
}
2. 添加刷课任务
添加一个新的刷课任务,提交后立即开始秒刷。
请求
POST /v1/course/smartedu-sc
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| username | string | 是 | 登录账号 |
| password | string | 是 | 登录密码 |
| course_name | string | 是 | 课程名称 |
| course_id | string | 是 | 课程ID(从查询接口获取) |
| desc | string | 否 | 备注说明 |
请求示例
{
"username": "13800138000",
"password": "your_password",
"course_name": "教师培训课程",
"course_id": "abc123",
"desc": "2024年培训"
}
响应示例
{
"code": 200,
"msg": "任务已提交,正在刷课中"
}
3. 获取刷课任务列表
获取当前用户的四川智慧教育刷课任务列表。
请求
GET /v1/course/smartedu-sc
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| username | string | 否 | 按账号筛选 |
| status | string | 否 | 按状态筛选: not_start/waiting/doing/done/fail/pause |
| page | int | 否 | 页码,默认1 |
| size | int | 否 | 每页数量,默认10 |
响应示例
{
"code": 200,
"msg": "success",
"data": [
{
"id": 1,
"createTime": "2024-12-09 10:00:00",
"updateTime": "2024-12-09 10:05:00",
"username": "13800138000",
"type": "smartedu_sc",
"course_name": "教师培训课程",
"course_id": "abc123",
"need": "task",
"status": "done",
"task_count": 20,
"success_count": 20,
"violence": "yes",
"desc": "2024年培训"
}
],
"total": 1
}
状态说明
| 状态值 | 说明 |
|---|---|
| not_start | 未开始 |
| waiting | 等待中 |
| doing | 进行中 |
| done | 已完成 |
| fail | 失败 |
| pause | 已暂停 |
4. 删除刷课任务
删除指定的刷课任务。
请求
DELETE /v1/course/smartedu-sc/{id}
路径参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | int64 | 是 | 任务ID |
响应示例
{
"code": 200,
"msg": "删除成功"
}
错误码说明
| 错误码 | 说明 |
|---|---|
| 200 | 成功 |
| 400 | 请求参数错误 |
| 401 | 未授权 |
| 403 | 无权限 |
| 500 | 服务器内部错误 |
使用流程
- 调用 查询课程列表 接口,获取用户在四川智慧教育平台的课程
- 选择需要刷的课程,调用 添加刷课任务 接口
- 任务提交后自动开始秒刷,可通过 获取刷课任务列表 查看进度
- 刷课完成后状态变为
done