Hivebrowser
API 参考

API 密钥

创建并管理用于程序化访问的 API 密钥。

用途机器到机器访问

只为后端服务、Worker、队列和自动化任务签发 API 密钥。

保护不要进入客户端

密钥放在密钥管理系统中，不暴露在浏览器包、移动端或日志里。

运营按归属轮换

按环境或服务拆分密钥，让轮换和事故响应更清楚。

运营边界

API 密钥只用于后端服务、Worker、队列和自动化任务。按环境或服务拆分密钥，存放在密钥管理系统中；工作流、供应商或人员变化时禁用旧密钥，并观察用量确认兜底路径已经退出。

创建 API 密钥

POST/v1/api-keys查看接口细节收起接口细节
POST/v1/api-keys

鉴权

Authorization必填Bearer <token>

在 Authorization 请求头中以 Bearer 令牌形式传入 API 密钥。

位置：header

x-hivebrowser-api-key<token>

也可以直接通过 x-hivebrowser-api-key 请求头传入 API 密钥。

位置：header

请求体

application/json必填
name必填字符串

API 密钥显示名称

最小长度: 1最大长度: 120
expiresAt字符串 | 空值

可选过期时间（ISO 8601）

格式: "date-time"
cURL
curl -X POST "https://api.hivebrowser.ai/v1/api-keys" \  -H "Authorization: Bearer <token>" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "expiresAt": "2019-08-24T14:15:22Z"  }'
JavaScript
fetch("https://api.hivebrowser.ai/v1/api-keys", {  headers: {    "Authorization": "Bearer <token>"  },  body: JSON.stringify({    "name": "string",    "expiresAt": "2019-08-24T14:15:22Z"  })});
响应 201

API 密钥已创建（包含密钥明文）

响应示例
{
  "data": {
    "id": "string",
    "teamId": "string",
    "name": "string",
    "keyPrefix": "string",
    "status": "ACTIVE",
    "lastUsedAt": "2019-08-24T14:15:22Z",
    "expiresAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "secret": "string"
  }
}
响应 400

请求载荷无效

响应示例
{
  "error": "string",
  "message": "string"
}
响应 401

API 密钥缺失或无效

响应示例
{
  "error": "string",
  "message": "string"
}

列出 API 密钥

GET/v1/api-keys查看接口细节收起接口细节
GET/v1/api-keys

鉴权

Authorization必填Bearer <token>

在 Authorization 请求头中以 Bearer 令牌形式传入 API 密钥。

位置：header

x-hivebrowser-api-key<token>

也可以直接通过 x-hivebrowser-api-key 请求头传入 API 密钥。

位置：header

cURL
curl -X GET "https://api.hivebrowser.ai/v1/api-keys" \  -H "Authorization: Bearer <token>"
JavaScript
fetch("https://api.hivebrowser.ai/v1/api-keys", {  headers: {    "Authorization": "Bearer <token>"  }});
响应 200

API 密钥列表

响应示例
{
  "data": {
    "items": [
      {
        "id": "string",
        "teamId": "string",
        "name": "string",
        "keyPrefix": "string",
        "status": "ACTIVE",
        "lastUsedAt": "2019-08-24T14:15:22Z",
        "expiresAt": "2019-08-24T14:15:22Z",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      }
    ],
    "total": 0,
    "page": 1,
    "pageSize": 0
  }
}
响应 401

API 密钥缺失或无效

响应示例
{
  "error": "string",
  "message": "string"
}

禁用 API 密钥

POST/v1/api-keys/{id}/disable查看接口细节收起接口细节
POST/v1/api-keys/{id}/disable

鉴权

Authorization必填Bearer <token>

在 Authorization 请求头中以 Bearer 令牌形式传入 API 密钥。

位置：header

x-hivebrowser-api-key<token>

也可以直接通过 x-hivebrowser-api-key 请求头传入 API 密钥。

位置：header

路径参数

id必填字符串

API 密钥 ID

cURL
curl -X POST "https://api.hivebrowser.ai/v1/api-keys/string/disable" \  -H "Authorization: Bearer <token>"
JavaScript
fetch("https://api.hivebrowser.ai/v1/api-keys/string/disable", {  headers: {    "Authorization": "Bearer <token>"  }});
响应 200

API 密钥已禁用

响应示例
{
  "data": {
    "id": "string",
    "teamId": "string",
    "name": "string",
    "keyPrefix": "string",
    "status": "ACTIVE",
    "lastUsedAt": "2019-08-24T14:15:22Z",
    "expiresAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
响应 401

API 密钥缺失或无效

响应示例
{
  "error": "string",
  "message": "string"
}
响应 404

资源不存在

响应示例
{
  "error": "string",
  "message": "string"
}

本页目录

运营边界创建 API 密钥列出 API 密钥禁用 API 密钥