开放 API 文档
为第三方开发者提供的公开接口,无需认证即可调用
基础信息
- 基础URL:
api/ - 数据格式: JSON
- 字符编码: UTF-8
- 跨域支持: 支持 CORS
公开接口
GET
/get_homework_by_date.php
公开
获取作业列表
按日期获取作业列表,支持调休日期自动处理。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| date | string | 否 | 查询日期,格式:YYYY-MM-DD,默认当天 |
| class_id | int | 否 | 班级ID,默认为1 |
加载中...
GET
/get_announcements.php
公开
获取系统公告
获取当前生效的系统公告。
加载中...
GET
/stats.php?action=get
公开
获取访问统计
获取系统访问统计数据。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| action | string | 是 | 固定值:get |
| hours | int | 否 | 获取最近N小时数据,默认24,最大720 |
加载中...
GET
/get_suggestions.php
公开
获取输入建议
根据关键词获取历史作业输入建议。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| keyword | string | 是 | 搜索关键词 |
加载中...
响应格式
统一响应格式
所有接口返回统一的JSON格式。
// 成功响应
{
"code": 0,
"message": "操作成功",
"data": { ... }
}
// 错误响应
{
"code": 500,
"error": "错误信息"
}
错误码说明
| 错误码 | 说明 |
|---|---|
| 0 | 成功 |
| 400 | 请求参数错误 |
| 401 | 未登录或密码错误 |
| 403 | 权限不足 |
| 404 | 资源不存在 |
| 500 | 服务器内部错误 |
需要认证的接口
以下接口需要登录认证,请联系管理员获取访问权限:
POST /add_homework.php- 添加作业POST /update_homework.php- 更新作业POST /delete_homework.php- 删除作业POST /submit.php- 提交作业POST /grade_submission.php- 批改作业POST /change_password.php- 修改密码