API使用文檔-候鳥防關聯瀏覽器

帳號登錄

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調試此接口