快速开始
获取API密钥
首先，您需要在学习通题库平台注册账号并申请API密钥。
- 访问 学习通题库官网
- 注册或登录账号
- 进入开发者中心
- 申请API密钥
- 获取 API Key 和 Secret
认证方式
所有API请求都需要进行认证。我们支持以下认证方式：
// 请求头中添加认证信息
Authorization: Bearer YOUR_API_KEY
X-API-Secret: YOUR_API_SECRET
API端点
1. 搜题接口
GET
/api/v1/search
搜索题目和答案
| 参数名 | 类型 | 必需 | 说明 |
|---|---|---|---|
| q | string | 是 | 搜索关键词 |
| page | integer | 否 | 页码，默认为1 |
| limit | integer | 否 | 每页数量，默认为10 |
| type | string | 否 | 题型：single, multiple, judge, fill, short |
请求示例
curl -X GET "https://api.ucuc.net/api/v1/search?q=光合作用&page=1&limit=10" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "X-API-Secret: YOUR_API_SECRET"
响应示例
{
"code": 200,
"message": "success",
"data": {
"total": 1000,
"page": 1,
"limit": 10,
"items": [
{
"id": "123456",
"title": "光合作用的过程",
"content": "光合作用分为...",
"answer": "光合作用分为光反应和暗反应两个阶段",
"type": "single",
"difficulty": "medium"
}
]
}
}
2. 答案查询接口
GET
/api/v1/answer/{id}
获取题目的详细答案和解析
| 参数名 | 类型 | 必需 | 说明 |
|---|---|---|---|
| id | string | 是 | 题目ID |
3. 用户信息接口
GET
/api/v1/user/info
获取当前用户信息
4. 统计接口
GET
/api/v1/stats
获取搜索统计数据
错误处理
API返回的错误信息遵循以下格式：
{
"code": 400,
"message": "Invalid request parameters",
"error": {
"field": "q",
"reason": "Search keyword is required"
}
}
常见错误码
| 错误码 | 说明 |
|---|---|
| 200 | 请求成功 |
| 400 | 请求参数错误 |
| 401 | 认证失败 |
| 403 | 权限不足 |
| 404 | 资源不存在 |
| 429 | 请求过于频繁 |
| 500 | 服务器错误 |
速率限制
⚠️ 注意： 免费用户每天限制100次API调用，VIP用户限制10000次。超出限制将返回429错误。
最佳实践
- 使用连接池提高性能
- 实现重试机制处理临时故障
- 缓存搜索结果减少API调用
- 监控API响应时间和错误率
- 定期更新API客户端库