🔌 外部控制
本服务提供外部控制 API，允许第三方应用或脚本与系统进行交互。
启用外部控制
- 进入 "设置" → "外部控制"
- 开启 "启用外部控制" 开关
- 配置 API 密钥（用于认证）
- 保存配置
API 文档
启用外部控制后，可以访问内置的 Swagger API 文档：
访问地址: http://您的服务地址:端口/api/docs
认证方式
所有外部控制 API 请求需要携带 API 密钥：
?api_key=YOUR_API_KEYAPI 接口列表
导入相关
| 接口 | 方法 | 说明 |
|---|---|---|
/api/control/import/auto | POST | 全自动搜索并导入 |
/api/control/search | GET | 搜索媒体 |
/api/control/import/direct | POST | 直接导入搜索结果 |
/api/control/episodes | GET | 获取搜索结果的分集列表 |
/api/control/import/edited | POST | 导入编辑后的分集列表 |
/api/control/import/url | POST | 通过URL导入弹幕 |
/api/control/import/xml | POST | 通过XML导入弹幕 |
弹幕库管理
| 接口 | 方法 | 说明 |
|---|---|---|
/api/control/library/anime | GET | 获取弹幕库列表 |
/api/control/library/anime | POST | 自定义创建作品 |
/api/control/library/anime/{animeId} | GET | 获取作品详情 |
/api/control/library/anime/{animeId} | PUT | 编辑作品信息 |
/api/control/library/anime/{animeId} | DELETE | 删除作品 |
/api/control/library/anime/{animeId}/sources | GET | 获取作品的所有数据源 |
/api/control/library/anime/{animeId}/sources | POST | 为作品添加数据源 |
/api/control/library/source/{sourceId} | DELETE | 删除数据源 |
/api/control/library/source/{sourceId}/favorite | PUT | 精确标记数据源 |
/api/control/library/source/{sourceId}/episodes | GET | 获取源的分集列表 |
/api/control/library/episode/{episodeId} | PUT | 编辑分集信息 |
/api/control/library/episode/{episodeId} | DELETE | 删除分集 |
/api/control/library/episode/{episodeId}/refresh | POST | 刷新分集弹幕 |
弹幕管理
| 接口 | 方法 | 说明 |
|---|---|---|
/api/control/danmaku/{episodeId} | GET | 获取弹幕 |
/api/control/danmaku/{episodeId} | POST | 覆盖弹幕 |
Token 管理
| 接口 | 方法 | 说明 |
|---|---|---|
/api/control/tokens | GET | 获取所有Token |
/api/control/tokens | POST | 创建Token |
/api/control/tokens/{tokenId} | GET | 获取单个Token详情 |
/api/control/tokens/{tokenId} | PUT | 更新Token信息 |
/api/control/tokens/{tokenId} | DELETE | 删除Token |
/api/control/tokens/{tokenId}/logs | GET | 获取Token访问日志 |
/api/control/tokens/{tokenId}/toggle | PUT | 启用/禁用Token |
/api/control/tokens/{tokenId}/reset | POST | 重置Token调用次数 |
任务管理
| 接口 | 方法 | 说明 |
|---|---|---|
/api/control/tasks | GET | 获取后台任务列表 |
/api/control/tasks/{taskId} | GET | 获取单个任务状态 |
/api/control/tasks/{taskId} | DELETE | 删除任务 |
/api/control/tasks/{taskId}/abort | POST | 中止正在运行的任务 |
/api/control/tasks/{taskId}/pause | POST | 暂停正在运行的任务 |
/api/control/tasks/{taskId}/resume | POST | 恢复已暂停的任务 |
/api/control/tasks/{taskId}/execution | GET | 获取执行任务ID和状态 |
定时任务管理
| 接口 | 方法 | 说明 |
|---|---|---|
/api/control/scheduler/tasks | GET | 获取所有定时任务 |
/api/control/scheduler/{taskId}/last_result | GET | 获取定时任务最近运行结果 |
流控状态
| 接口 | 方法 | 说明 |
|---|---|---|
/api/control/rate-limit/status | GET | 获取流控状态（支持SSE流式推送） |
设置管理
| 接口 | 方法 | 说明 |
|---|---|---|
/api/control/settings/danmaku-output | GET | 获取弹幕输出设置 |
/api/control/settings/danmaku-output | PUT | 更新弹幕输出设置 |
/api/control/config | GET | 获取可配置的参数列表 |
/api/control/config | PUT | 更新指定配置项 |
🧪 接口调试
以上接口仅列出了路径和基本说明。
详细的请求参数、响应格式、字段说明等信息，请在搭建项目后访问内置的 Swagger 文档进行查看和测试：
http://您的服务地址:端口/api/docsSwagger 文档提供：
- 完整的参数说明和类型定义
- 在线测试功能（可直接发送请求）
- 请求/响应示例
- 错误码说明
📚 相关文档
- 🔗 Webhook 配置 - 自动化触发
- 🎬 弹幕API功能配置 - Token管理
- 📱 客户端配置 - 播放器配置