比特浏览器API接口怎么调用？

创建窗口——调用/browser/update接口，在请求体中传入窗口名称和指纹参数（如内核版本coreVersion），成功后会返回窗口ID，作为后续操作的“钥匙”。打开窗口——调用/browser/open接口传入窗口ID，启动浏览器进程。执行任务后关闭——调用/browser/close接口释放资源，避免占用系统性能。

比特浏览器API接口怎么调用？

比特浏览器Local API是什么？

• Local API是比特浏览器提供的本地HTTP服务接口，运行在用户电脑上，用于通过编程方式控制浏览器操作：调用本地API接口可以操作比特浏览器打开、配置代理等，帮助用户实现自动化脚本功能。它本质上是一个运行在本地的微型服务器，默认端口为54345，允许开发者发送HTTP请求来创建、打开、关闭、删除浏览器窗口，配置指纹参数和代理设置，实现与自动化脚本的深度集成。
• Local API的核心价值是将比特浏览器的防关联能力与自动化脚本深度集成，实现大规模自动化场景：对于需要大规模、高仿真的自动化场景来说，这是目前最实用、最稳定的解决方案之一。自动化脚本的灵活性与指纹环境的稳定性被完美结合，用户可以通过编程方式批量创建数百个不同指纹配置的环境并并行执行自动化任务，大幅提升运营效率。
• 官方提供多种语言的示例代码帮助开发者快速上手，降低开发门槛：比特浏览器官方文档提供了JavaScript、Python、E语言等编程语言的Demo代码，以及Postman调试导入文件。开发者可根据自己的技术栈选择对应的示例代码，快速理解接口调用方式，大幅降低Local API的学习和开发门槛，让开发者能够迅速将Local API集成到自己的自动化工作流中。

Local API的运行模式与结构

• Local API采用请求-响应模式，所有通信均通过本地HTTP协议完成：用户的脚本向http://127.0.0.1:54345发送POST请求，携带JSON格式的参数。Local API服务接收并处理请求，将指令转发给比特浏览器核心执行，然后将执行结果以JSON格式返回给脚本，实现完整的请求-响应闭环。
• Local API接口的请求方式均为POST，传参方式均为body传参（JSON格式）：接口不接受request url、formdata或string等传参方式。接口返回JSON对象，success为true表示操作成功，数据附加在data字段中；返回success为false时，表示业务失败，失败信息会附加到msg字段中，便于开发者快速定位问题。
• 典型的自动化工作流程包含创建、打开、执行、关闭四个步骤：首先调用/browser/update接口创建带有独立指纹配置的浏览器窗口，获取返回的浏览器ID；然后用/browser/open接口启动该窗口，获取调试地址供自动化框架连接；接着用Selenium或Playwright连接到该窗口执行自动化操作；最后调用/browser/close接口关闭窗口，释放系统资源。

如何开启和获取Local API服务地址？

开启Local API服务的操作步骤

• 第一步：安装并登录比特浏览器客户端，进入系统设置开启Local API：用户需要先安装比特浏览器客户端并登录账号，然后打开客户端，点击右上角用户头像旁的箭头图标进入系统设置，找到Local API相关选项，确保“开启本地API”或“启用HTTP接口”已开启。默认端口为54345，可理解为本地运行的迷你服务器，开启后客户端会启动本地HTTP服务等待请求。
• 第二步：获取Local API的本地接口地址，通常为http://127.0.0.1:54345：在系统设置中找到Local API的URL地址，这是后续所有API调用的基础URL，用于向本地服务发送HTTP请求。如端口被占用可手动修改，需确保防火墙未拦截该端口的本地通信，否则API调用将无法正常响应。
• 第三步：下载官方示例代码或准备开发环境，开始调用接口：用户可以从比特浏览器文档页面下载JavaScript或Python的示例代码。使用Python开发时，只需安装requests库即可开始发送HTTP请求与Local API通信。建议开发调试阶段先用Postman验证接口，确认服务正常响应后再进行脚本开发，避免参数格式错误导致的程序异常。

Local API服务状态验证

• 确认比特浏览器客户端处于运行状态且已登录账号：Local API服务依赖于比特浏览器客户端的运行，关闭客户端后API将不可用。自动化脚本需确保客户端处于运行状态，建议在脚本中增加客户端状态检测逻辑，确保调用API前客户端已正常启动并登录。
• 通过/health接口检测本地服务是否正常连接：调用/health接口可检测Local API服务是否正常运行，返回成功说明服务已就绪。这是开发调试阶段验证环境配置的首选方法，可在编写复杂脚本前确认基础通信链路畅通。
• 建议先用Postman调试接口再开发脚本，避免参数格式错误：因参数传递方式特殊（body传参JSON格式），建议先用Postman调通接口确认参数正确，再进行脚本开发。Postman调试文件可从官方获取，包含所有接口的预配置请求示例，调试时注意检查请求的Content-Type是否为application/json。

Local API的请求和响应格式是怎样的？

请求格式规范与参数传递方式

• 所有接口请求方式均为POST，参数通过body传递（JSON格式）：接口请求方式均为post，传参方式均为body传参。使用其他方式（如GET请求或query string）会导致请求失败。请求的Content-Type需设置为application/json，参数按接口定义规范传递，不要随意删改参数或传递未知意义的值，否则可能导致程序出错甚至闪退。
• 每个接口有自己独立的参数定义，需按照接口文档中的字段名称和数据类型严格传递：创建或修改窗口时，接口参数必须符合规范，不要随意删改参数或传递未知意义的值或类型。参考官方接口文档中的字段定义和示例进行开发。/browser/update接口的指纹参数覆盖操作系统、分辨率、时区、Canvas等数十项字段，应按文档规范填写。
• 创建窗口时需注意内核版本与操作系统的兼容性：coreVersion指定浏览器内核版本（如124），win7/win8/winserver 2012已经不支持112及以上内核，无法打开窗口。在这些系统上应使用104内核，否则窗口创建成功但无法打开。指纹对象中除了coreVersion外，还有webrtc、webRTC、canvas、webgl等多个高级指纹参数，留空则自动随机生成。

响应格式规范与错误处理

• 接口返回统一的JSON对象，success为true表示操作成功：接口返回json对象，success为true作成功，如有返回数据，附加在data对象中。成功创建窗口时，data字段中包含窗口ID，该ID是后续所有操作的“钥匙”。/browser/open接口返回的data中包含http地址（供Selenium连接使用）和driver路径（WebDriver可执行文件路径）。
• 接口返回success为false时表示业务失败，失败信息附加到msg中：接口返回success为false时，表示业务失败，可能是程序原因或参数校验等原因，失败信息会附加到msg中。开发者应根据msg内容进行针对性排查，快速定位问题根源，如“参数错误”“分组id必传”“窗口不存在”等具体错误描述。
• 建议使用Postman先调试接口，确认参数格式和响应结构正确：先用Postman调通接口，确认参数格式和响应结构正确后再进行脚本开发。Postman调试文件可从官方渠道获取，包含所有接口的预配置请求示例，调试时注意检查请求的Content-Type是否为application/json。

如何通过Python调用Local API创建和打开浏览器窗口？

创建浏览器窗口配置文件

• 第一步：调用/browser/update接口创建带有独立指纹配置的浏览器窗口：核心参数包括窗口名称、代理方式、代理类型和指纹对象。指纹对象中的coreVersion指定浏览器内核版本（如124），注意Windows 7/8已不支持112及以上内核。创建成功后返回窗口ID，该ID是后续所有操作的唯一标识。代理对象中的proxyType支持http、https、socks5等多种协议。
• 第二步：指纹参数支持自定义或留空自动随机生成：指纹对象中包含webrtc、webRTC、canvas、webgl、audioContext、fontType、timeZone、language等多项高级指纹参数。留空的字段系统会自动随机生成一套逻辑自洽的参数，确保每个窗口的指纹独立且真实。如需精细控制，可手动指定每个参数的具体值。
• 第三步：代理配置与指纹参数联动，确保IP归属地与指纹逻辑一致：创建窗口时可同时配置代理IP，支持HTTP、HTTPS、SOCKS5等多种协议。代理绑定后，窗口的网络请求通过代理IP转发，实现网络层隔离。建议导入代理IP后让系统自动匹配对应的时区、语言、地理位置等指纹参数。

打开窗口并连接自动化框架

• 第一步：调用/browser/open接口启动已创建的浏览器窗口：传入窗口ID即可启动浏览器。返回结果中包含http地址（格式为127.0.0.1:端口号，供Selenium连接使用）和driver路径（WebDriver可执行文件路径）。建议在调用/open后等待2-4秒，让浏览器进程完全初始化。
• 第二步：从返回结果中提取debuggerAddress和driverPath配置到Selenium：将http地址配置到Selenium的ChromeOptions中，通过chrome_options.add_experimental_option("debuggerAddress", debuggerAddress)连接。driverPath指向比特浏览器自带的ChromeDriver，确保路径正确。连接成功后即可使用Selenium的标准API执行自动化操作。
• 第三步：执行自动化操作后通过/browser/close接口关闭窗口：不要在Selenium中调用driver.quit()关闭窗口，应通过/browser/close接口关闭，否则可能损坏配置文件状态。正确的流程是：创建配置文件→启动窗口获取调试地址→Selenium连接执行操作→调用close接口关闭。整个流程可完全编程化，支持批量并行处理。

Local API支持哪些核心操作？

浏览器窗口的完整生命周期管理

• 支持创建或更新窗口（/browser/update）：可创建带有独立指纹配置的浏览器窗口，传入操作系统、分辨率、时区、Canvas、WebGL等全部指纹参数和代理配置。创建成功后返回窗口ID。支持更新已存在的窗口配置，修改指纹参数或代理设置后需重新打开窗口才能生效。
• 支持打开、关闭和删除窗口（/browser/open、/browser/close、/browser/delete）：/browser/open启动窗口并返回调试地址供自动化框架连接，/browser/close关闭指定窗口释放系统资源，/browser/delete删除窗口环境。关闭和删除的区别在于：关闭只是停止运行，删除会移除环境配置。
• 支持获取窗口详情（/browser/detail）和分页获取窗口列表（/browser/list）：可获取当前账号下所有已创建的窗口列表，包含窗口ID、名称、分组、指纹配置、代理状态等完整信息。支持按分组筛选窗口，便于批量管理。

批量操作与窗口管理

• 批量更新窗口配置（/browser/update/partial）：支持批量更新多个窗口的配置参数，包括窗口名称、分组标签等。适合在大规模运营中统一调整环境配置，避免逐个手动修改的低效操作。
• 批量更新分组（/browser/group/update）和代理设置（/browser/proxy/update）：可批量修改多个窗口的分组归属，便于按业务线重新组织环境。代理设置支持为多个窗口统一更换代理IP，适合代理失效后的快速恢复场景。
• 批量删除窗口（/browser/delete/ids）和按序号关闭窗口（/browser/close/byseqs）：支持传入多个窗口ID批量删除，或按序号范围批量关闭窗口。适合在大规模环境中快速清理不再需要的窗口，释放系统资源和套餐配额。

调用Local API时需要注意哪些问题？

接口调用规范与限制

• 确保比特浏览器客户端处于运行状态且已登录：Local API服务依赖于比特浏览器客户端的运行，关闭客户端后API将不可用。自动化脚本需确保客户端处于运行状态，建议在脚本中增加客户端状态检测逻辑。调用API前确认用户已登录比特浏览器账号。
• 所有接口仅支持POST请求，参数为JSON格式：Local API不接受GET、PUT等请求方法，也不支持query string或form-data传参。务必使用POST方法并在请求体中传递JSON格式的参数，否则接口将无法正确处理请求。建议先使用Postman调试接口确认调用成功，再进行脚本开发。
• 参数按规范传递，不要随意删改或传递未知意义的值：创建或修改窗口时，接口参数必须符合规范，不要随意删改参数或传递未知意义的值或类型，否则可能导致程序出错甚至闪退。参考官方接口文档中的字段定义和示例进行开发。

运行环境与常见问题排查

• 内核版本需与操作系统兼容：创建窗口时需注意操作系统与内核版本的兼容性。win7/win8/winserver 2012已经不支持112及以上内核，无法打开窗口。在这些系统上应使用104内核，否则窗口创建成功但无法打开。如遇到创建失败提示，可尝试切换至较低版本内核。
• 建议先用Postman调试再开发脚本，避免参数格式错误：因参数传递方式特殊（body传参JSON格式），建议先用Postman调通接口再开发脚本。Postman调试文件可从官方获取，包含所有接口的预配置请求示例。调试时注意检查请求的Content-Type是否为application/json。
• 端口冲突与防火墙配置：Local API默认端口为54345，如端口被其他程序占用可手动修改。需确保防火墙未拦截该端口的本地通信，否则API调用将无法正常响应。如果API连接被拒绝，首先检查比特浏览器是否正在运行，其次确认端口号是否正确。

常见问题FAQ