WebDisk API 说明

用途：让外部 Agent 通过密钥文件只读访问白板与需求文档。

基础地址：

使用流程

1. 用户登录 WebDisk 后，进入应用内「API说明」页。
2. 点击「下载密钥文件（仅一次）」并妥善保存。
3. Agent 从密钥文件读取 token 后访问接口。
4. 文件丢失时，由管理员在应用内执行「重置下载状态」后重新下载。

权限说明

• 密钥仅可调用下方 /api/agent/* 三个接口：读白板、读需求、 标记需求完成。
• 密钥不能访问文件（上传/下载/删除）、写白板、管理通行密钥或 修改密码——这些操作只认浏览器登录会话。
• 密钥泄漏的影响因此被限制在「白板与需求可被读取」。

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": "..."
        }
      ]
    }
  ]
}