启动浏览器(POST)
最近更新:2024-09-29 20:07:58
基础信息
POST /api/v1/browser/start
接口说明
· 功能:post方式启动浏览器。
· 协议: http
· method: post
· uri: /api/v1/browser/start
请求参数
参数 | 说明 | 类型 | 必填 | 可选值 | 默认值 |
env_id | 浏览器id,环境导入成功后生成的唯一id | string | 是 | ||
custom_data | 自定义数据。启动的环境后,从localStorage的customData变量中读取 | any | 否 | ||
headless | 是否无头浏览器 | string | 否 | 不传:否 1:是 | 不传 |
append_cmd | 浏览器启动指令 | string | 否 | ||
bypasslist | 绕过代理 | string | 否 | bypass list域名用,分隔 | |
no_sandbox | number | 否 | 0、1 | ||
urls | 指定打开urls | string[] | 否 | ||
cookies | string | 否 | |||
proxy | 代理配置信息 | object | 否 | ||
blacklist | 黑名单 | string[] | 否 | ||
remote_debugging | 开启远程调试 | number | 否 | 开启RPA调试 1:开启 0:关闭(默认) | |
remotedebuggingaddress | 远程地址 | string | 否 | 远程控制,局域网ip地址 |
data结构体配置
参数 | 说明 | 类型 | 可选值 | 默认值 |
protocol | 协议 | string | socks5 | |
host | ipt地址 | string | ||
port | 端口 | number | ||
userName | 账号 | string | ||
password | 密码 | string |
请求示例
http://127.0.0.1:50230/api/v1/browser/start?env_id=337a934fa89244a183c64**********
请求体
{
"env_id": "60d70438977a4517a83*********",
"urls": [
"www.baidu.com", "www.163.com"
],
"append_cmd": "",
"cookies": "",
"proxy": {
"protocol": "http",
"host": "192.168.0.171",
"port": 10809,
"userName": "",
"password": ""
},
"blacklist": [
"taobao.com"
],
"remote_debugging": 1,
"remote_debugging_address": ""
}
RPA
入参
{
...
"remote_debugging": 1
}
返回信息
{
"code": 0,
"msg": "success",
"data": {
"status": "Active",
"ws": {
"selenium": "127.0.0.1:53785",
"puppeteer": "ws://127.0.0.1:53785/devtools/browser/3f868b43-4f3f-4e7b-8faf-8f2d7e79d6cc"
},
"debuggingPort": "53785",
"webdriver": "D:\\test\\browser-api\\browser\\chrome119-1.0.1.3\\chromedriver.exe"
}
}
返回数据
参数 | 说明 | 类型 | 可选值 | 默认值 |
code | 执行状态码 | int | 0:成功 -1:输入格式错误 -2:获取数量异常 | |
msg | 返回成功或者失败消息 | string | ||
data | 返回数据 | object |
data结构体配置
参数 | 说明 | 类型 | 可选值 | 默认值 |
status | 浏览器状态 | Active:浏览器已打开运行中 Inactive:浏览器未打开 |
执行成功
{
"code": 0,
"msg": "success",
"data": {
"status": "Active"
}
}
执行失败
{
"code":-1,
"data":{},
"msg":"failed"
}
code状态码
code | 备注 |
0 | 成功 |
-1 | 服务器错误 |
-2 | appid缺失 |