版本 2.4.8 · 最新
API 密钥 api-keys
当前用户的 API 密钥。密钥明文只在创建时返回一次,可按领域限定授权范围。
点击任一接口,右侧显示对应的调用示例。
用户账号鉴权: 用户4 个接口
鉴权
请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。
X-API-Key
鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。
约定
分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。
时间一律 RFC 3339(UTC);金额单位为分。
写操作成功回 200/201/204;重复提交按资源唯一键回 409。
GET
/api/v2/api-keys列出 API Key
鉴权: 用户
查询参数
| 字段 | 类型 | 说明 |
|---|---|---|
page | integer | 页码,从 1 开始。 |
page_size | integer | 每页条数。 |
sort | string | 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。 |
POST
/api/v2/api-keys创建 API Key
鉴权: 用户
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
allow_ips | ApiKeyAllowIps | 调用 IP 白名单(只收单个 IP,最多 200 个);空 = 不限。不在名单里的调用按凭据无效回 401。 |
expires_at | string | 过期时间 |
name必填 | string | 名称 |
password | string | 当前登录口令(操作者本人的);与 totp_code 至少给一个,复核本人。 |
scopes必填 | string[] | 授权范围,取值同创建时的 scopes。 |
totp_code | string | 操作者本人动态口令(TOTP)的 6 位当前码;账号须已启用动态口令。 |
PUT
/api/v2/api-keys/{id}修改 API Key 的 IP 白名单或重置
鉴权: 用户
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
allow_ips | ApiKeyAllowIps | 调用 IP 白名单(只收单个 IP,最多 200 个);空 = 不限。不在名单里的调用按凭据无效回 401。 |
password | string | 当前登录口令(操作者本人的);与 totp_code 至少给一个,复核本人。 |
reset | boolean | 为 true 时换新 key,旧 key 立即失效。 |
totp_code | string | 操作者本人动态口令(TOTP)的 6 位当前码;账号须已启用动态口令。 |
API 密钥对象
| 字段 | 类型 | 说明 |
|---|---|---|
allow_ips | ApiKeyAllowIps | 调用 IP 白名单(只收单个 IP,最多 200 个);空 = 不限。不在名单里的调用按凭据无效回 401。 |
created_at | string | 创建时间 |
expires_at | string | 过期时间 |
id | integer | 记录 ID |
last_used_at | string | 最近一次使用时间;从未使用为空。 |
name | string | 名称 |
password | string | 当前登录口令(操作者本人的);与 totp_code 至少给一个,复核本人。 |
prefix | string | 明文的前几位,便于辨认。 |
reset | boolean | 为 true 时换新 key,旧 key 立即失效。 |
scopes | string[] | 授权范围,取值同创建时的 scopes。 |
secret | string | 明文 key(X-API-Key 的值),只在创建时返回一次;库里只存哈希。 |
totp_code | string | 操作者本人动态口令(TOTP)的 6 位当前码;账号须已启用动态口令。 |
updated_at | string | 更新时间 |
返回与错误
成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。
成功
{
"id": 1,
"name": "example"
}列表
{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}失败
{
"code": "validation_failed",
"detail": "请求参数不合法",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name 必填"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}