mirror of
https://github.com/HackPlan/RootPanel.git
synced 2026-04-22 19:03:34 +08:00
49 lines
1.2 KiB
Markdown
49 lines
1.2 KiB
Markdown
## JSON API 格式
|
||
|
||
请求和响应均为 `application/json` 格式，大部分 API 均为 POST 方式。
|
||
|
||
响应代码为 200 表示成功，400 表示失败。成功会返回特定的数据，失败的响应会包含错误代号：
|
||
|
||
{
|
||
// 错误代号
|
||
"error": "username_exist"
|
||
// 根据错误代号不同，可能还有更多字段
|
||
}
|
||
|
||
## 登录验证
|
||
|
||
登录验证可通过 Cookie 和 HTTP Header 两种方式验证，后者优先级更高。
|
||
Cookie 字段名为 `token`, HTTP Header 名为 `X-TOKEN`.
|
||
验证失败时会发生 `auth_failed` 错误。
|
||
|
||
## 分页
|
||
limit 和 skip 参数用于分页，limit 表示要返回的结果数量，skip 表示跳过前若干条结果，limit 默认为 30, skip 默认为 0.
|
||
|
||
## 用户组
|
||
|
||
* root - 全站最高管理员
|
||
|
||
## 工单系统
|
||
|
||
### 工单的状态
|
||
|
||
* open
|
||
|
||
开放的。
|
||
管理员向用户创建工单后，或管理员回复工单后，默认是这个状态。
|
||
|
||
* pending
|
||
|
||
等待管理员回复。
|
||
用户回复工单后，变为这个状态。
|
||
|
||
* finish
|
||
|
||
被标记为完成的。
|
||
用户提出某项要求，管理员完成后，变为这个状态。
|
||
|
||
* closed
|
||
|
||
已关闭。
|
||
管理员或用户均可关闭一个工单。
|