比特指纹浏览器的API文档位于官方帮助中心，中文文档地址为 https://bitbvsrowaser-apps.com/，国际用户可访问 https://bitbvsrowaser-apps.com/。本地API服务默认地址为 http://127.0.0.1:54345，所有接口请求方式均为POST，采用body传参json格式，返回json对象。文档提供了Python、JavaScript、E语言等多种编程语言的示例代码，以及Postman调试demo可直接导入使用。核心接口包括创建/修改窗口（/browser/update）、打开窗口（/browser/open）、关闭窗口（/browser/close）、删除窗口（/browser/delete）、获取窗口列表（/browser/list）等。建议使用Postman先调试接口，调通后再进行脚本开发。
比特指纹浏览器API文档的官方入口在哪里？
API文档入口位于官方帮助中心
- API文档的官方入口在比特指纹浏览器的帮助中心：在比特指纹浏览器官网中，有专门的API接口文档页面，用于提供详细的接口调用说明。用户可通过访问帮助中心或文档中心找到API文档入口。
- 文档按功能模块分类展示：API文档涵盖了浏览器窗口管理、指纹配置、代理设置等核心功能的接口说明。文档中对每个接口的请求方式、参数类型、返回数据格式都有明确描述。
- 文档同时提供多语言示例代码：官方API文档不仅包含接口参数说明，还提供了JavaScript、Python、E语言等多种编程语言的调用示例代码，方便不同技术背景的开发者快速上手。
文档地址与访问方式
- 中文文档地址为https://bitbvsrowaser-apps.com/：比特指纹浏览器的API文档主站为https://bitbvsrowaser-apps.com/，同时也提供https://bitbvsrowaser-apps.com/供用户访问。国际用户可通过doc.bitbrowser.net访问英文版文档。
- 文档包含完整的接口调用线路图：官方文档提供了本地服务的接口使用概述，包括请求方式均为POST、参数传递方式均为body传参、返回json格式数据等核心规范说明。
- 文档持续更新：随着比特浏览器版本的迭代，API文档会同步更新，新增接口和参数变更会及时在文档中反映。用户在使用API时应参考最新版本的文档说明。
本地API服务的地址和端口是什么？
默认地址为127.0.0.1:54345
- 本地API服务的默认地址为http://127.0.0.1:54345：比特指纹浏览器的本地API服务默认监听在54345端口。API的请求方式均为POST，传参方式均为body传参，返回json格式数据。
- 固定端口在3.0.2版本中正式支持：比特指纹浏览器在3.0.2版本中正式支持Local Api固定端口，并支持端口修改，同时兼容旧版通过读配置文件方式获取服务端口的方式。用户可在系统设置中查看和调整本地API服务端口。
- 端口在客户端设置中查看：用户可在比特浏览器客户端的系统设置中查看“本地接口url”，即当前API服务地址。该地址也是调用API时使用的base url。
API调用的基础规范
- 请求方式与传参方式：所有接口的请求方式均为POST，参数传递方式均为body传参（json格式），不接受request url、formdata、string等类型传参方式。建议使用Postman先调试接口，调通后再进行脚本开发调用。
- 接口返回格式统一：所有接口返回json对象，success为true表示成功，附加数据在data对象中；success为false表示业务失败，失败信息附加在msg字段中。
- 示例代码可直接运行：官方文档提供了Python、JavaScript、E语言等示例代码，用户可基于示例快速搭建自己的自动化脚本。例如创建窗口的Python代码中，只需指定
url = "http://127.0.0.1:54345"即可调用。
API支持哪些核心操作接口？
浏览器窗口管理接口
- 支持创建/修改浏览器窗口的
/browser/update接口：该接口用于创建新浏览器窗口或修改已有窗口配置。创建时需要传入指纹对象browserFingerPrint，如果只需要随机指纹，传空对象{}即可。该接口功能包括设置窗口名称、平台URL、代理信息、指纹参数等。 - 支持打开窗口的
/browser/open接口：通过传入窗口id即可启动对应的浏览器窗口，返回ws和http连接地址，以及内核版本和chromedriver路径等信息。在3.0.2版本中还新增了extractIp参数，可尝试自动提取IP。 - 支持关闭窗口的
/browser/close接口和删除窗口的/browser/delete接口：传入窗口id即可完成对应操作。同时支持/browser/list接口获取浏览器窗口列表，以及/browser/detail接口获取窗口详情。
高级管理接口
- 支持窗口排列调整的
/windowbounds接口：该接口用于排列窗口以及调整窗口尺寸，支持宫格排列和对角线排列两种方式，参数type可选择box或diagonal。 - 支持批量更新窗口的
/browser/update/partial接口：该接口支持批量更新窗口配置，通过传入ids数组和需要修改的字段，即可实现批量修改窗口的备注、分组、指纹等配置。 - 支持健康检查接口测试服务连通性：使用
/health接口可测试本地Local Server是否连接成功，无需传入任何参数。这是调试API连接状态的常用接口。
如何调用API创建和修改浏览器窗口？
创建窗口的核心接口
- 使用
/browser/update接口创建窗口：创建窗口时需传入窗口名称name、平台URLplatform、代理信息proxyMethod和proxyType，以及指纹对象browserFingerPrint。如果只需要系统随机生成的指纹，传空对象{}即可。 - 代理配置的两种方式：
proxyMethod为2时表示自定义代理，需同时传入host、port、proxyUserName、proxyPassword等字段；proxyMethod为3时表示提取IP，需传入dynamicIpUrl等字段。 - 创建成功后返回窗口ID：调用
/browser/update接口后，返回结果中的data.id即为新创建窗口的唯一标识，后续打开、关闭、修改操作均需要此ID。
修改窗口的两种方式
- 完整修改使用
/browser/update接口：传入窗口id和需要修改的完整参数，即可全量更新窗口配置。此方式会覆盖所有字段，因此需要传入完整的指纹对象。 - 部分修改使用
/browser/update/partial接口：此接口支持按需更新，只传入需要修改的字段即可，不需要修改的字段可以省略。例如修改备注时只需传入{'ids': ['窗口ID'], 'remark': '新备注'}。批量更新时ids传入数组即可同时修改多个窗口。 - 指纹对象可在创建时灵活配置：创建窗口时可通过
browserFingerPrint对象自定义指纹参数，包括操作系统os、内核版本coreVersion、Canvas指纹canvas、WebGL指纹webGL等。例如指定coreVersion: '112'可创建112内核的浏览器环境。
如何调用API打开和关闭浏览器窗口？
打开窗口接口
- 使用
/browser/open接口启动浏览器：传入窗口id即可启动对应的浏览器窗口。返回结果中包含ws（websocket连接地址）、http（http连接地址）、coreVersion（内核版本）和driver（chromedriver路径）。 - 打开时可传入启动参数：通过
args参数可传入浏览器启动参数，例如传入["--headless"]启动无头模式，或传入["--load-extension=xxx/extension/path"]加载自定义插件。 - 打开时可控制是否加载插件和提取IP：通过
loadExtensions参数控制是否加载扩展中心已启用的插件；通过extractIp参数控制是否尝试自动提取IP。
关闭窗口接口
- 使用
/browser/close接口关闭浏览器：传入窗口id即可关闭对应的浏览器进程。该接口会正常关闭浏览器，确保数据正确保存。 - 关闭后再启动可恢复窗口配置：关闭窗口后，窗口的配置数据仍然保留，再次调用
/browser/open可重新启动，之前的配置和Cookie数据依然有效。 - 删除窗口需使用
/browser/delete接口：如需彻底删除窗口环境，需调用/browser/delete接口。删除后的窗口不可恢复，执行前需确认。
API接口的请求规范和调试方法有哪些？
接口请求规范
- 所有接口均为POST请求，body传参，json格式：Local Api的所有接口参数传递方式为body传参，json格式，不接受request url、formdata、string等类型传参方式。调用时需在请求头中设置
Content-Type: application/json。 - 参数需符合文档规范：使用Local Api创建或修改窗口时，接口参数必须符合规范，不要随意删改参数，不要传递未知意义的值或类型，否则可能导致程序出错甚至闪退。
- 接口返回统一格式：接口返回json对象，
success为true表示成功，附加数据在data对象中；success为false表示业务失败，失败信息附加在msg字段中。
调试方法
- 推荐使用Postman调试：官方建议使用Postman调试接口，调通后再进行脚本开发调用。官方提供了Postman调试demo可直接导入使用。
- 使用健康检查接口测试连接：调用
/health接口可测试本地Local Server是否连接成功，无需任何参数。这是排查API连接问题的首选方式。 - 查看系统设置获取本地接口url：安装并登录比特浏览器后，在系统设置中可获取到本地接口url地址，此地址即为API调用的base url。
API常见问题及注意事项有哪些？
参数使用注意事项
- 参数类型必须符合规范：调用API时参数类型必须与文档一致，例如窗口排列接口中的
startX、startY、width等参数类型都必须是整型数字。传递错误类型可能导致接口调用失败。 - 传参方式必须为body传参：所有接口均使用POST方式，参数通过body传递json格式数据。使用按键精灵等工具调试时如提示传参格式不对，通常是因为使用了其他传参方式。
- 创建子账号窗口时分组id必传：使用子账号创建浏览器窗口时，
groupId分组id必传，否则窗口会创建到主账号下面。
常见使用场景与建议
- 调用API前需确保本地服务正常运行：API调用依赖本地Local Server服务，使用API前需确保比特浏览器客户端已开启并登录。如调用
/browser/list等接口前需检查服务状态。 - 内核版本与系统兼容性：Win7/Win8/Windows Server 2012已不支持112及以上内核版本，使用
coreVersion参数时需注意系统兼容性。建议在Win10及以上系统使用112或124内核。 - 第三方库可简化调用：社区已提供了封装好的Python模块（如bitnet-api），通过
from bitnet_api import BrowserFingerPrint即可使用实体类配置指纹参数，调用方式更加简便。
常见问题FAQ
比特指纹浏览器API文档在哪个地址？
API文档中文版在 doc.bitbrowser.cn（doc.bitbrowser.net 为国际站），同时 doc2.bitbrowser.cn/jiekou.html 也是官方文档入口。所有接口均为POST请求、body传json格式，返回json对象。
本地API服务地址和端口是多少？
API支持哪些核心接口？
包括：/health健康检查、/browser/update创建/修改窗口、/browser/open打开窗口、/browser/close关闭窗口、/browser/delete删除窗口、/browser/list获取窗口列表。创建窗口时指纹对象
browserFingerPrint必传，只需随机指纹可传空对象{}。调用API时有哪些注意事项？
参数必须符合规范，传递错误类型或未知值可能导致程序闪退。建议用Postman先调试接口，调通后再开发脚本。接口返回
success为true表示成功，false表示失败，失败信息在msg字段。