手册 › LynxBoard 看板

3 接口参考

接口通用约定

项目约定
地址http://设备IP:端口（默认 6556）
数据格式请求与响应均为 JSON
认证除登录、注册外，需请求头 Authorization: Bearer <token>
成功响应{"success": true, "data": ...} 或 {"success": true, "message": ...}
失败响应{"success": false, "message": "错误说明"}
状态码400 参数错误；401 未登录或令牌过期；403 无权限；404 不存在；409 账户已存在
  • 接口均以 /api 开头，其它地址返回网页本身；允许跨域，浏览器可直接调用。
  • 获取令牌：
curl -s -X POST http://设备IP:6556/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"******"}'
# 响应中的 data.token 即令牌，默认有效期 7 天

账户与权限接口

方法路径说明
POST/api/auth/register注册账户（开放），自动创建默认看板
POST/api/auth/login登录，返回令牌、用户信息与当前看板
GET/api/auth/me获取当前用户信息与偏好
PUT/api/auth/profile更新昵称与偏好
GET/api/admin/check判断是否已创建管理员
POST/api/admin/setup首次初始化创建管理员（仅在无管理员时可用）
GET/api/admin/users成员列表（管理员）
POST/api/admin/users创建成员（管理员）
DELETE/api/admin/users/:id删除成员（管理员，不能删除自己）
PUT/api/admin/users/:id/reset-password重置成员密码（管理员）

注册 / 登录请求体：

{ "username": "alice", "password": "secret6+" }

密码至少 6 位；用户名重复返回 409；登录成功返回 token、user、board。

看板、列与卡片接口

全部需要登录令牌。id 均为接口返回的字符串标识。

看板

方法路径说明
GET/api/boards当前用户可见的看板列表
GET/api/boards/:id单个看板完整结构（列、卡片、标签）
POST/api/boards新建看板，参数 {title, description}
PUT/api/boards/:id更新看板；共享开关仅所有者可改
DELETE/api/boards/:id删除看板（所有者）
GET/api/boards/:id/export导出看板 JSON

列

方法路径说明
POST/api/boards/:id/columns新增列，参数 {title, color}
PUT/api/boards/:id/columns/:columnId更新列，参数 {title, color, order, hideOlderCards}
DELETE/api/boards/:id/columns/:columnId删除列

卡片

方法路径说明
POST/api/boards/:id/columns/:columnId/cards新增卡片
PUT/api/boards/:id/cards/:cardId更新卡片（未提供的字段保持原值）
DELETE/api/boards/:id/cards/:cardId删除卡片
PUT/api/boards/:id/cards/:cardId/move移动卡片，参数 {toColumnId, toIndex}

卡片请求体示例：

{
  "title": "采集任务 A",
  "description": "每日抓取并汇总",
  "priority": "high",
  "tags": ["Bug"],
  "dueDate": "2026-10-30",
  "createdDate": "2026-10-25",
  "notifyTime": "2026-10-26T09:00"
}

priority 取值：urgent / high / medium / low；notifyTime 格式为 YYYY-MM-DDTHH:mm。

邮件提醒接口

方法路径说明
GET/api/notifications/recipients收件人列表
POST/api/notifications/recipients添加收件人 {name, email, enabled}
PUT/api/notifications/recipients/:id更新收件人
DELETE/api/notifications/recipients/:id删除收件人
GET/api/notifications/smtp查看发邮配置（不回显密码）
PUT/api/notifications/smtp保存发邮配置，密码留空表示保留原值
POST/api/notifications/test-email发送测试邮件