用途:让外部 Agent 通过密钥文件访问系统 API(权限跟随密钥所属用户)。
基础地址:
使用流程
- 用户登录 WebDisk 后,进入应用内「API说明」页。
- 点击「下载密钥文件(仅一次)」并妥善保存。
- Agent 从密钥文件读取
token后访问接口。 - 文件丢失时,由管理员在应用内执行「重置下载状态」后重新下载。
权限说明
- 密钥可调用系统全部 API(文件、白板、需求等)。
- 执行权限与该密钥所属用户一致。
1. 读取白板
- 方法:
GET - 路径:
/api/agent/board -
鉴权:
Authorization: Bearer <密钥文件中的 token>
cURL 示例
返回示例
{
"ok": true,
"version": 12,
"content": "<p>白板当前内容</p>",
"contentBytes": 1234,
"historyEnabled": false
}
2. 读取需求文档
- 方法:
GET - 路径:
/api/agent/requirements - 可选参数:
?project=项目ID(过滤单个项目) - 鉴权:同上
cURL 示例
返回示例
{
"ok": true,
"totalItems": 5,
"projects": [
{
"id": "webdisk",
"name": "webdisk",
"items": [
{
"id": "req_17123...",
"content": "添加需求文档功能",
"status": "doing",
"priority": "high",
"createdAt": "...",
"updatedAt": "..."
}
]
}
]
}