浏览器接口
创建、修改、打开浏览器等操作接口
健康检查接口,无参数,可以用来测试Local Server是否连接成功
POST
/health
创建/修改浏览器窗口,指纹对象必传。创建窗口需要随机指纹对象时,只传空对象{}即可,指纹值里,留空会随机
POST
/browser/update
Request Body
Name | Type | Description |
---|---|---|
id | String | 浏览器窗口id,传id时为修改,不传为创建 |
groupId | String | 分组id,子账号创建浏览器窗口shi ,分组id必传,否则会创建到主账号下面 |
platform* | String | 账号平台URL,如:https://www.facebook.com |
platformIcon* | String | 账号平台Icon,默认填写platform字段的hostname即可 |
url* | String | 额外打开的url,多个用,分开 |
name* | String | 浏览器窗口名称 |
remark* | String | 备注 |
userName* | String | 浏览器平台账号 |
password* | String | 浏览器平台账号密码 |
cookie | String | 平台账号cookie,json格式的cookie字符串,必须符合标准,参考示例 |
proxyMethod* | Int | 代理类型,2自定义,3提取IP,默认2 注意:设置提取IP时,需要同时设置下方dynamicIpUrl等几个字段值 |
proxyType* | String | 自定义代理类型 ['noproxy', 'http', 'https', 'socks5', '911s5']中一个,默认noproxy |
host | String | 代理主机 |
port | Int | 代理端口 |
proxyUserName | String | 代理账号 |
proxyPassword | String | 代理密账号码 |
ip | String | 911 s5 ip |
country | String | 911 s5 国家地区code |
province | String | 911 s5 州/省code |
city | String | 911 s5 城市code |
browserFingerPrint* | Obect | 指纹对象,参考以下对象 |
isIpNoChange | Boolean | 911是否不改变IP,默认false |
abortImage | Boolean | 禁止加载图片,默认false |
stopWhileNetError | Boolean | 网络不通停止打开,默认false |
dynamicIpUrl | proxyMethod = 3时,提取IP链接 | |
dynamicIpChannel | String | 提取链接服务商,rola | doveip | cloudam | common |
isDynamicIpChangeIp | Boolean | 提取IP,每次打开都提取新IP,默认false |
syncTabs | Boolean | 是否同步浏览器tabs ,默认true |
syncCookies | Boolean | 同步Cookie,默认true |
syncIndexedDb | Boolean | 同步IndexedDB,默认false,极少的情况下才需要同步 |
syncBookmarks | Boolean | 同步书签,默认false |
syncAuthorization | Boolean | 同步已保存的密码,默认false |
syncHistory | Boolean | 同步历史记录,默认false |
isValidUsername | Boolean | 根据平台,用户名,密码,校验重复, false,创建时有效 |
ipCheckService | String | IP库,默认ip-api,选项 ip-api | ip123in | luminati,luminati为Luminati专用 |
allowedSignin | Boolean | 允许google账号登录浏览器,默认true |
clearCacheFilesBeforeLaunch | Boolean | 启动前清理缓存文件 |
clearCookiesBeforeLaunch | Boolean | 启动前清理cookie |
clearHistoriesBeforeLaunch | Boolean | 启动前清理历史记录 |
randomFingerprint | Boolean | 每次启动均随机指纹 |
disableGpu | Boolean | 是否关闭GPU硬件加速,默认false |
enableBackgroundMode | Boolean | 关闭浏览器后继续运行应用,默认false |
muteAudio | Boolean | 浏览器静音,默认false |
abortMedia | Boolean | 禁止视频自动播放,默认false |
workbench | String | 浏览器窗口工作台页面,chuhai2345 或 localServer或disable,默认chuhai2345,不需要显示工作台时,设置disable |
isIpv6 | Boolean | IP协议,是否是IPv6,默认false |
isGlobalProxyInfo | Boolean | 是否使用全局的动态代理信息,针对iphtml,oxylabs,lumauto,ipidea动态代理 |
syncExtensions | Boolean | 同步扩展应用数据,默认false |
syncUserExtensions | Boolean | 跨窗口同步扩展应用,默认false |
credentialsEnableService | Boolean | 禁止保存密码弹窗,默认false |
syncLocalStorage | Boolean | 同步Local Storage数据,默认false |
打开浏览器窗口,返回ws和http连接地址,以及coreVersion内核版本和driver,chromedriver path
POST
/browser/open
Request Body
Name | Type | Description |
---|---|---|
id* | String | 浏览器窗口id |
args | Array | 浏览器启动参数,注意不要传错了,数组类型,例如无头模式可以传 ["--headless"],使用非扩展中心中上传的插件可以传 ["--load-extension=xxx/extension/path"],多个插件使用逗号分隔 |
loadExtensions | Boolean | 是否加载扩展中心中已启用的插件 |
extractIp | Boolean | 是否尝试自动提取IP |
关闭浏览器窗口
POST
/browser/close
Request Body
Name | Type | Description |
---|---|---|
id* | String | 浏览器窗口id |
删除浏览器
POST
/browser/delete
Request Body
Name | Type | Description |
---|---|---|
id* | String | 浏览器窗口id |
获取浏览器窗口详情
POST
/browser/detail
Request Body
Name | Type | Description |
---|---|---|
id | String | 浏览器窗口id |
获取浏览器窗口列表
POST
/browser/list
Request Body
Name | Type | Description |
---|---|---|
page* | Int | 分页,从0开始 |
pageSize* | Int | 分页数量,最大,100,超出100仍然返回100条 |
groupId | String | 分组id,非必填 |
name | String | 窗口名称,模糊查询,非必填 |
remark | String | 备注,模糊匹配 |
seq | Int | 序号,精确查询 |
minSeq | Int | 最小序号,范围查询,不可与seq同时使用 |
maxSeq | Int | 最大序号,范围查询,不可与seq同时使用 |
排列窗口以及调整窗口尺寸
POST
/windowbounds
注意,参数除了type,其他参数类型都必须是整型数字。参考以下 windowbounds 对象。
Request Body
Name | Type | Description |
---|---|---|
type* | String | 排列方式,宫格 box , 对角线 diagonal |
startX* | Int | 起始X位置,默认0 |
startY* | Int | 起始Y位置,默认0 |
width* | Int | 宽度,最小500 |
height* | Int | 高度,最小200 |
col* | Int | 宫格排列时,每行列数 |
spaceX* | Int | 宫格横向间距,默认0 |
spaceY | Int | 宫格纵向间距,默认0 |
offsetX* | Int | 对角线横向偏移量 |
offsetY* | Int | 对角线纵向偏移量 |
批量修改浏览器窗口分组
POST
/browser/group/update
Request Body
Name | Type | Description |
---|---|---|
groupId* | String | 分组ID,从分组管理中获取,必填 |
browserIds* | Array | 浏览器窗口ID数组,必填 |
批量修改窗口代理信息
POST
/browser/proxy/update
Request Body
Name | Type | Description |
---|---|---|
ids* | Array | 浏览器窗口ID数组,必填 |
ipCheckService* | String | IP查询渠道,默认ip-api,选项 ip-api | ip123in | luminati,luminati为Luminati专用 |
proxyMethod* | int | 代理方式,2 自定义代理,3 提取IP,默认2 |
proxyType | String | 代理类型 noproxy|http|https|socks5,默认noproxy |
host | String | 代理主机 |
proxyUserName | String | 代理用户名 |
proxyPassword | String | 代理密码 |
dynamicIpUrl | String | 提取IPurl |
dynamicIpChannel | String | 提取IP服务商 rola|ipidea|deoveip|cloudam |
isDynamicIpChangeIp | Boolean | 默认true |
isGlobalProxyInfo | Boolean | false |
port | Int | 代理端口 |
isIpv6 | Boolean | 是否是IPv6,默认false |
批量修改窗口备注
POST
/browser/remark/update
Request Body
Name | Type | Description |
---|---|---|
browserIds* | Array | 浏览器ID数组 |
remark* | String | 备注 |
通过序号批量关闭窗口
POST
/browser/close/byseqs
Request Body
Name | Type | Description |
---|---|---|
seqs* | Array | 要关闭的窗口序号数组,如:[101, 103, 105] |
更新窗口与指纹指定字段值,支持批量修改
POST
/browser/update/partial
只传需要更新的字段即可,如需要更新name,则只传name
Request Body
Name | Type | Description |
---|---|---|
ids* | Array | 要更新的窗口ids集合,单个更新时,传一个id即可,如: ["abd8fd953d3641a0915865a09b8d99ba"] |
browserFingerPrint* | Object | 指纹对象,传入要更新的对应指纹字段即可,无调整,则放空对象{}即可 |
其他参数如 name | String | 更新那个,传入哪个,不更新的不需要传 |
获取已打开窗口的进程id集合,也可以用来判断窗口是否已打开,支持批量查询
POST
/browser/pids
Request Body
Name | Type | Description |
---|---|---|
ids* | Array | 窗口id集合,数组类型 |
获取所有活着的已打开的窗口的进程ID,会自动过滤掉已死掉的进程,无参数
POST
/browser/pids/all
获取活着的给定窗口的pids,会检查进程,减少进程退出,但是窗口状态没关闭的问题
POST
/browser/pids/alive
Request Body
Name | Type | Description |
---|---|---|
ids* | Array | 窗口id集合,数组类型 |
批量删除窗口,一次最多100个,彻底删除记录,包括缓存
POST
/browser/delete/ids
Request Body
Name | Type | Description |
---|---|---|
ids* | Array | 窗口id集合,数组类型,必传 |
windowbounds对象
browserFingerPrint指纹对象
最后更新于