Annil Token 管理
考虑到多客户端的使用场景,Anniv
实现了一套对 Annil Token
的管理系统,供客户端之间同步 Token
信息。
错误一览
错误代码 | 详情 |
---|---|
104000 | 用户 Token 存储数已达上限 |
104001 | Token 不存在 |
获取 Token
Endpoint
GET /api/credential
返回
返回包含所有请求 Token & Id & Controlled
的数组。
返回参数
Token
的定义如下所示:
参数名 | 类型 | 详情 |
---|---|---|
name | string | Annil 名称 |
url | string | Annil 站点地址 |
token | string | Annil Token 内容 |
priority | number | 客户端尝试访问时的优先级 |
Controlled
的定义如下所示:
参数名 | 类型 | 详情 |
---|---|---|
controlled | boolean | 该 Token 是否为受控 Token ,不可修改 |
对于受 Anniv
管理的 Token
,其 controlled
属性为 true
。客户端无法修改除 priority
之外的任何属性;对于用户手动添加的 Token
,则可以修改其他字段。
参数表示
type GetTokensResponse = (Token & Id & Controlled)[];
type Controlled = { controlled: boolean };
interface Token {
name: string;
url: string;
token: string;
priority: number;
}
新增 Token
用户可以通过该接口,令 Anniv
保存自定义的 Token
信息。
Endpoint
POST /api/credential
请求
新增请求的类型为 Token
。
返回
新建成功后,返回创建完成的 Token
信息(Token & Id & Controlled
)。
错误列表
错误代码 | 详情 |
---|---|
104000 | 用户 Token 存储数已达上限 |
修改 Token
用户可以修改当前存在的 Token
信息。
Endpoint
PATCH /api/credential
请求
修改请求的类型为 Partial<Token> & Id
。
错误列表
错误代码 | 详情 |
---|---|
104001 | Token 不存在 |
删除 Token
Endpoint
DELETE /api/credential
请求
请求参数
参数名 | 类型 | 详情 |
---|---|---|
id | string | 待删除 Token 的 ID |
错误列表
错误代码 | 详情 |
---|---|
104001 | Token 不存在 |
104002 | 无法删除受控 Token |