跳转到正文

API 管理

API 管理用于配置本机 Local API,让本机脚本或自动化框架控制中屹浏览器。此页面只能在桌面客户端中使用;网页端不会提供 API 服务配置和本机调用日志。

具体接口、请求参数和返回示例请查阅 Local API 在线文档

启用 API 服务

首次使用时,先生成并保存 API Key,再打开启用 API开关。密钥只会在生成或重置后的弹窗中完整显示一次;关闭弹窗后无法再次查看。重置密钥会立即使旧密钥失效,因此需要同步更新已接入的脚本或服务。

页面顶部会显示运行中已停止启动失败状态。启动失败时可查看错误提示并点击重试;右上角的刷新按钮可重新读取当前服务状态。

API 服务配置
API 服务配置
编号功能说明
1服务状态显示 API 是否运行、启动失败信息及启动时间
2启用 API只有已生成 API Key 后才能开启服务
3API Key生成或重置调用接口所需的身份凭据
4API 接口地址默认地址为 http://local.zhongyibrowser.com:端口/api/v1,可复制到本机程序中使用
5备用地址默认使用 127.0.0.1 的同端口地址;主地址无法访问时仅限本机替代使用
6文档入口服务运行后可打开本机 Swagger
在线文档可直接跳转到 Apifox
7刷新服务状态刷新当前 API 服务状态

WARNING

API Key等同于本机 API 的访问凭据。不要将其写入截图、日志、公开仓库或聊天内容;请使用环境变量或安全的密钥管理方式提供给业务程序。

查看接口文档与接入示例

服务运行后,点击打开 Swagger可查看本机地址上的交互式接口文档。需要在浏览器外查看完整说明时,点击打开在线文档,或直接访问 Local API 在线文档

页面底部的集成示例可展开 Puppeteer、Playwright 和 Selenium 示例。选择框架后,还可选择 JavaScript、TypeScript、Python 或 Java 等可用语言,复制示例代码并替换其中的 API Key 和环境 ID;环境 ID 可在 查看与查找环境 中确认。每个框架页签均提供其官方文档跳转链接。

API 集成示例
API 集成示例

排查 API 调用

API 调用日志会记录 Local API 的请求和响应。可按接口路径或请求 ID 搜索,并按请求方法和成功/失败状态筛选;列表显示时间、方法、路径、状态码和耗时。点击查看详情后,可分别检查请求和响应中的 Header、路径参数、Query、Body 与响应内容,并复制所需字段。

日志支持手动刷新、分页和清空。清空操作不可恢复,排查问题时建议先保留失败请求的时间、请求 ID 和响应信息,再执行清理。

API 调用日志
API 调用日志

当服务处于启动失败时,先处理状态卡片中的错误信息并重试;当请求失败时,再从调用日志确认请求地址、API Key、请求方法和返回内容。接口字段、鉴权格式和完整错误码以 Local API 在线文档 为准。