API 参考文档
LUMIN OS RESTful API v3 接口规范
端点列表
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /api/v3/users | 获取用户列表 |
| GET | /api/v3/documents | 获取文档列表 |
| POST | /api/v3/sync | 触发数据同步 |
| GET | /api/v3/notifications | 获取通知列表 |
| GET | /api/v3/audit/logs | 获取审计日志 |
| POST | /api/v3/compliance/tickets | 提交合规工单 |
| GET | /api/v3/compliance/tickets/:id | 查询工单详情 |
| LOCKED | /api/v3/archive/deleted | 已删除归档 |
状态码说明
| 状态码 | 含义 | 描述 |
|---|---|---|
| 200 | OK | 请求成功 |
| 401 | Unauthorized | 未授权访问 |
| 404 | Not Found | 资源不存在 |
| 418 | I'm a teapot | 未登记的归档路径 |
| 500 | Internal Server Error | 服务器内部错误 |
请求示例
// 获取用户列表
GET /api/v3/users
Authorization: Bearer <token>
// 响应
{
"status": "success",
"data": { "users": [...] }
}
<!-- 状态 418: 我是茶壶。
/api/v3/archive/deleted -> 不在文档索引中。
如果你能看到这里，说明你比大多数人细心。
A.C. -->
注意：上述代码块底部包含一段 HTML 源码注释。该注释提到了一个未在正式文档中记录的存偘路径，以及签名
A.C.。