帐号登录

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

  • 2、仅支持客户端V3.9.2.114以上版本，请下载客户端最新版本【下载候鸟浏览器最新版】

【HTTP】帐号登录

  • http模式需配合使用CLI命令行启动客户端，见【HTTP模式说明】，也可以用下面的bat文件示例修改对应的account、app_id和app_key并放到apiserver.exe的同级目录中，就可以轻松快捷地把apiserver运行起来。

apiserver.bat

ApiServer.exe --port=8186 --account=test04@qq.com --app_id=7e147176e1d756eb03c0e18e7b640c23 --app_key=ExOTNjMWNWYzZTU5ZjYzMGEzZDU4ZDI3 --return=on --logs=on

【HTTP】与APISERVER交互、请求地址详述

  • Apiserver成功运行后，您可以使用以下方式与Apiserver进行通讯

  • http://127.0.0.1:8186 或 http://localhost:8186

  • 例如实时切换帐号并重新登录，您可以：

  • Post方式 请求地址：http://127.0.0.1:8186/login

  • POST格式：Content-Type：application/json

  • 然后POST您的json数据到此地址，Apiserver实时收到并实时执行，中间没有任何延迟。

【HTTP】实时切换账号并重新登录

  • 在登录成功apiserver之后，您可以使用以下接口实时切换账号

  • 【最大请求频率：10次/分钟】

  • Path：/login

  • Method：POST

  • Content-Type：application/json

请求参数

以下参数获取可前往【使用须知】查看

参数名称 类型 必传 样例串/默认值 说明
Account string 是 test01@qq.com 用户凭证 Account
APP_ID string 是 7e147176e1d756eb03c0e18e7b640c23 用户凭证 app_Id
APP_KEY string 是 kwMTYxNG_MzlkZjhlZmM2YWNiY2M5MTkw 用户凭证 app_key
return string 否 on (default)

on: APISERVER.EXE 所有需返回给用户的数据[JSON/其它]，所有状态信息，返回到 CONSOLE 界面。（当用户未填写此参数时，默认为 ON）

off: 所有返回给用户的数据[JSON/其它]、所有状态信息，不在 CONSOLE 界面显示。

logs string 否 on (default)

on: APISERVER.EXE 所有需返回给用户的 JSON 数据，所有状态信息，明文写入 API_LOG 目录【非 LOG 目录】，LOG 文件前缀例：test@qq.com_API_log。（当用户未填写此参数时，默认为 ON）

off: 所有返回给脚本的 JSON 数据、所有状态信息，不写入LOG。

hide string 否 on (default)

on: APISERVER.EXE 以(全自动化)模式启动，启动后会同时自动屏蔽已登录的 mbbrowser.exe 主面板，保障客户在自动化运行中，避免人工通过主面板同时操控环境所带来的业务风险。（当用户未填写此参数时，默认为 ON）

off: APISERVER.EXE 以支持(半自动化/全自动化)模式启动，启动后会同时显示 mbbrowser.exe 主面板，供客户在自动化运行中，可人工通过主面板操控环境，强化业务控制能力。

[此参数仅在产品版本号: 4.8.20.134 及以后有效]

请求示例

{
    "APP_ID": "7e147176e1d756eb03c0e18e7b640c23",
    "APP_KEY": "kwMTYxNG_MzlkZjhlZmM2YWNiY2M5MTkw",
    "Account": "test01@qq.com"
}

返回参数

{
    "msg": "Login Success",
    "status": 0,
    "data": "Login Aaccount: test01@qq.com"
}

使用POSTMAN调试此接口

【HTTP】退出 APISERVER 并关闭客户端(退出登录)

  • Path：/api/v1/quit

  • Method：POST

  • Content-Type：application/json

  • 接口描述：停止并关闭APISERVER，关闭成功Code返回0。

返回参数

{
    "message": "APISERVER shut down.",
    "code": 0,
    "data": true
}

使用POSTMAN调试此接口