> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hybridbox.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Hybridbox 公共 API

> 使用 Hybridbox 公共 API 管理账户、域名、邮箱、DNS 记录、转发规则、主密码、标签、工作区和专用 IP。

# Hybridbox 公共 API

## 身份验证

REST API 使用 OAuth 2.0 bearer 访问令牌。

浏览器或 Web 应用集成获取令牌的步骤：

1. 使用 Hybridbox Web 应用公共客户端启动标准 OAuth 授权码流程。
2. 将用户发送到 Hybridbox 授权端点，并请求常用的 OpenID scope。
3. 用户登录后，在 Hybridbox 令牌端点用返回的授权码交换令牌。公共浏览器客户端应使用 PKCE；服务器端 Web 应用应在后端完成代码交换。
4. 从令牌响应中读取 `access_token`。

在需要身份验证的 REST API 请求中使用访问令牌：

```http theme={null}
Authorization: Bearer <access_token>
```

API 会验证令牌签发者，并要求使用允许的公共客户端 ID，包括 Hybridbox Web 应用客户端。端点页面会列出已认证用户或组所需的任何额外权限。

## OpenAPI 规范

下载完整的公共 API 合约：[openapi.json](/openapi.json)。