Local API V2 的调用方式与 V1 一样:先确认本机端口和 Local API Key,再按接口地址发起 HTTP 请求。
V2 接口路径统一以 /openapi/v2 开头,例如 /openapi/v2/profiles、/openapi/v2/proxies、/openapi/v2/fingerprints。
基础地址
Local API 服务运行在本机端口上,完整请求地址格式为:
http://127.0.0.1:{port}/openapi/v2/...
示例:
GET http://127.0.0.1:52100/openapi/v2/profiles
{port} 为客户端显示或配置的 Local API 端口。示例中的端口、环境 ID、代理 ID 和 API Key 都需要替换为你的实际值。
请求头
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
X-API-KEY | string | 是 | Local API Key。 |
Content-Type | string | 有请求体时建议传 | 固定为 application/json。 |
X-Token | string | 否 | 可选认证头。普通调用通常不需要填写。 |
说明:
- 请使用
X-API-KEY调用接口。 - 有请求体的接口请传合法 JSON。
- 参数不符合要求时,会返回对应的错误信息。
响应格式
V2 使用统一响应包络:
{
"code": 0,
"msg": "success",
"data": {},
"next": null
}
| 名称 | 类型 | 说明 |
|---|---|---|
code | integer | 业务状态码。0 表示成功。 |
msg | string/null | 响应消息。 |
data | object/null | 响应数据。不同接口结构不同。 |
next | string/null | 游标分页的下一页标记。无下一页时为 null。 |
常见错误:
| HTTP | code | 说明 |
|---|---|---|
| 401 | 401000 | 缺少 X-API-KEY。 |
| 403 | 401000 | X-API-KEY 与本地配置不匹配。 |
| 429 | 429000 | 请求过于频繁。 |
| 502 | 502000 | 服务暂不可用。 |
| 502 | 502001 | 服务响应异常。 |
| 504 | 504000 | 请求超时。 |
分页规则
部分列表接口支持两种分页方式:
| 方式 | 参数 | 说明 |
|---|---|---|
| 页码分页 | page、page_size | page 从 1 开始。 |
| 游标分页 | cursor、limit | 第一次请求不传 cursor;下一页使用响应中的 next。 |
page/page_size 与 cursor/limit 互斥,不要混用。
分页列表响应示例:
{
"code": 0,
"msg": "success",
"data": {
"list": [],
"total": 0,
"summary": null
},
"next": null
}
接口范围
当前支持 72 个 V2 接口:
| 模块 | 数量 | 说明 |
|---|---|---|
| 运行状态 Runtime | 9 | 服务状态、版本、健康状态、频控、运行环境、批量停止和可用内核。 |
| 环境 Profiles | 19 | 环境增删改查、账号、分组移动、代理绑定、启动/停止等。 |
| 扩展与书签 | 8 | 环境书签、环境扩展设置、扩展安装、扩展列表和扩展分组。 |
| 标签 Tags | 6 | 标签增删改查,以及给环境添加或移除标签。 |
| 环境分组 | 5 | 环境分组增删改查。 |
| 成员与权限 | 8 | 成员增删改查、成员可访问分组、成员分组和权限查询。 |
| 代理 Proxies | 7 | 代理增删改查和代理检测。 |
| Cookie | 4 | Cookie 查询、导入和清空。 |
| 指纹 Fingerprints | 6 | 指纹查询、覆盖、刷新、生成和选项查询。 |
模块文档
| 模块 | 接口数 | 文档 |
|---|---|---|
| 运行状态 Runtime | 9 | 查看运行状态接口 |
| 环境 Profiles | 19 | 查看环境接口 |
| 扩展与书签 | 8 | 查看扩展与书签接口 |
| 标签 Tags | 6 | 查看标签接口 |
| 环境分组 | 5 | 查看环境分组接口 |
| 成员与权限 | 8 | 查看成员与权限接口 |
| 代理 Proxies | 7 | 查看代理接口 |
| Cookie | 4 | 查看 Cookie 接口 |
| 指纹 Fingerprints | 6 | 查看指纹接口 |
调用提示
- 所有 V2 接口路径都需要包含
/openapi/v2。 - 所有请求都需要携带正确的
X-API-KEY。 - 有请求体的接口请使用 JSON 格式,并设置
Content-Type: application/json。 - 创建、更新、导入类接口建议先使用少量数据验证,再批量调用。
- 启动环境成功后,可以使用响应中的
debug_port或web_socket_url连接浏览器。 - 遇到 429 时请降低请求频率,并参考响应头中的
Retry-After、X-RateLimit-*。