候鸟浏览器脚本自动化API服务是一种基于控制台的应用程序，它提供了强有力的环境控制与浏览器操作API，让开发人员和测试人员能够轻松地进行候鸟浏览器的管理，从而实现自动化测试和开发。该服务完整支持候鸟的浏览器内核，并且具有多重优势，包括简单易用、支持多种浏览器、多种函数支持、可扩展性强、提供详细错误日志和调试信息等等。此外，候鸟浏览器脚本自动化API服务还支持自定义设置和配置，例如代理地址、超时时间等等，满足用户个性化需求。借助该服务，开发人员和测试人员可以大大提高工作效率和减少人为错误，是一款非常实用的自动化环境管理商用工具。

• 候鸟浏览器支持本地API的功能，帮助用户通过程序化的方式来启动和关闭浏览器等基础API功能，还可以配合Selenium和Puppeteer等自动化框架来实现浏览器操作的自动化。

• 后续客户端 API将持续更新。

• 采用HTTP模式连接

• 命令行唤起候鸟浏览器

• 1、以管理员身份运行CMD或者PowerShell，并确保终端在候鸟浏览器主目录打开，或已进入候鸟浏览器主路径

• cmd运行以下语句

• ApiServer.exe --port=8186 --account=XXXXX --app_id=XXXXX --app_key=XXXXX –-retrun=on –-logs=on

• PowerShell运行以下语句

• .\ApiServer.exe --port=8186 --account=XXXXX --app_id=XXXXX --app_key=XXXXX –retrun=on –logs=on

• 2、启动成功过后在命令行工具可以看到API地址

• 参数带入account、app_id、app_key，则在右下角的托盘菜单看见软件图标，标明已登入，可以调用接口运行脚本

• 若未带入account、app_id、app_key参数，可在后续通过登录帐号接口登录客户端。见接口文档。

3、CLI命令行参数介绍

 --port         [可选]    http连接端口 (default 8186)        --account      [可选]    凭证APP_ID      --app_id       [可选]    凭证APP_ID      --app_key      [可选]    凭证APP_KEY      --retrun        [on/off，默认为on]    APISERVER.EXE 所有需返回给用户的数据[JSON/其它]，所有状态信息，返回到 CONSOLE 界面。      --logs          [on/off，默认为on]    APISERVER.EXE 所有需返回给用户的 JSON 数据，所有状态信息，明文写入 API_LOG 目录【非 LOG 目录】，LOG 文件前缀例：test@qq.com_API_log。

停止并退出APISERVER

• 在操作系统右下角TRAY区的APISERVER图标上点击右键，唤出菜单，点击退出并完成退出APISERVER动作。也可以通过任务管理器等强制退出。

接口说明

• 支持以下接口

帐号登录：启动客户端

获取成员列表：获取主帐号与子帐号数据

浏览器环境：打开环境、关闭环境、强制终止环境

环境管理：获取环境列表、查询指定环境的配置数据、创建环境、更新环境高级指纹参数、更新环境、更新环境代理、删除环境、导入Cookie、导出Cookie、获取随机UA、清除环境本地缓存

分组管理：获取环境分组列表、新建环境分组、删除环境分组、转移环境分组.