API 密钥

创建 API 密钥

POST /api/v1/api-keys

为已认证用户创建新的 API 密钥。

请求正文

{
  "name": "My integration"
}

字段	必填	描述
`name`	是	密钥的显示名称（1-100 个字符）

响应

{
  "data": {
    "id": "key_uuid",
    "name": "My integration",
    "prefix": "rm_abc123",
    "key": "rm_abc123def456...",
    "created_at": "2025-09-19T15:00:00.000Z"
  }
}

列出 API 密钥

GET /api/v1/api-keys

返回已认证用户的所有 API 密钥。完整的密钥值在创建后永不返回。

响应

{
  "data": [
    {
      "id": "key_uuid",
      "name": "My integration",
      "prefix": "rm_abc123",
      "created_at": "2025-09-19T15:00:00.000Z",
      "last_used_at": "2025-09-20T10:30:00.000Z",
      "is_revoked": false
    }
  ]
}

撤销 API 密钥

DELETE /api/v1/api-keys/:id

永久撤销一个 API 密钥。使用此密钥的请求将立即失败，并显示 INVALID_API_KEY。

响应

{
  "data": { "success": true }
}

错误代码

代码	HTTP 状态	含义
`API_KEY_NOT_FOUND`	404	密钥不存在或属于其他用户
`ALREADY_REVOKED`	400	密钥已撤销