创建窗口浏览器

请求方法以及路径

POST http://localhost:[端口号]/openapi/window/browser/create?ticket=[OpenApi票据]

接口功能描述

用于创建窗口浏览器。

请求参数

Header 请求参数

参数名	参数值	必填	类型	描述
Content-Type	application/json	是	String	application/json

Body 请求参数

参数名	是否必须	类型	说明
windowName	是	string	自定义的窗口名称（字符长度在 2 到 30 个之间）
ipProxySetting	是	object	关于代理的配置信息对象查看配置对象详解
browserSettingInfo	是	object	关于浏览器内核的配置信息对象查看配置对象详解
advancedSettingInfo	是	object	关于窗口的高级配置信息对象查看配置对象详解
shouldChangeFingerprint	否	bool	默认值 true; true: 表示需要更换指纹；false: 表示延续上一次打开的指纹 注意:当为false 时,browserSettingInfo 与 advancedSettingInfo 的设置将无效，因为要延续上一次打开的指纹
openUrlArray	否	string	默认打开的链接(一行只写一个网址\r\n，网址后不要有自己添加的任何修饰符！且字符长度在 0 到 200 之间)
notes	否	string	窗口的备注（字符长度在 0 到 16 之间）

请求参数示例

{
  "windowName": "bj111y",
  "ipProxySetting": {
    "type": "null",
    "host": "11",
    "port": "2324",
    "account": "",
    "password": ""
  },
  "browserSettingInfo": {
    "brand": "chrome",
    "version": "122.0.6261.95"
  },
  "advancedSettingInfo": {
    "webRTC": "disabled",
    "platform": "Win32",
    "useragentMode": "strict"
  },
  "shouldChangeFingerprint": true,
  "openUrlArray": "https://www.baidu.com\r\nhttps://www.51job.com",
  "notes": "窗口的备注信息"
}

参数详解

ipProxySetting 配置参数对象键值详解

参数名	是否必须	类型	说明
type	是	string | null	代理类型：[socks5 | https| http | null] null 为直连模式，不使用代理
host	是	string	代理主机 (200 个字符以内)
prot	是	string	代理端口（不超过 65535 的正整数字符串 或 ''）
account	否	string	代理的账号 (200 个字符以内)
password	否	string	代理的密码 (100 个字符以内)

browserSettingInfo 配置参数对象键值详解

参数名	是否必须	类型	说明
brand	是	string	内核类型与具体支持的内核版本需要通过接口进行动态的获取 点击查看获取文档
version	是	string

advancedSettingInfo 配置参数对象键值详解

参数名	是否必须	类型	说明
webRTC	是	string	webRTC 取值：[disabled | really]
platform	是	string	platform 取值：[Win32 | MacIntel| iPhone | iPad| Android]
useragentMode	是	string	useragentMode 取值：[really | common| strict]

openUrlArray 参数详解

openUrlArray 为字符串类型数据，长度在 0 到 200 之间，多个网址间使用\r\n进行隔开。

接口响应结果示例

成功响应示例

返回参数

newWindowBrowserKey 是新创建窗口的唯一标识。

{
  "code": "00000",
  "message": "Success",
  "data": {
    "status": "success",
    "errorCode": "",
    "errorMsg": "",
    "result": {
      "newWindowBrowserKey": 123
    }
  }
}

失败响应示例

调用接口失败

接口响应状态码，不为00000时，接口调用失败。
具体接口调用错误原因可查看接口响应状态码信息对照表进行查询。

{
  "code": "00001",
  "message": "产生未知错误，请反馈给官方客服！",
  "data": {}
}

本次创建操作失败

{
  "code": "00000",
  "message": "Success",
  "data": {
    "status": "failed",
    "errorCode": "E01",
    "errorMsg": "缺少参数(xxx)",
    "result": {}
  }
}

操作失败 errorCode 错误码信息对照表

错误码	错误原因
E00	参数(xxx)格式有误！
E01	缺少参数 (xxx) 。
E02	参数存在多余 。
E03	ipProxySetting 中缺少参数(xxx) 。
E04	ipProxySetting 中的参数存在多余 。
E05	窗口唯一编号 key 马上要超过最大允许值：1000 了，请删除部分靠后的列表项然后重试！
E06	windowName 【窗口名称】的字符串长度必须是 2 ～ 30 之间 。
E07	ipProxySetting.type 【代理类型】必须是: socks5、https、http、null 其中的一种且必填 （null 表示：直连模式，即：不使用代理）。
E08	ipProxySetting.host 【代理主机】字符长度必须是 1 ～ 200 之间 ， 且仅当 ipProxySetting.type 为null时，ipProxySetting.host 可以为空字符串。
E09	ipProxySetting.port 【代理端口】必须是正整数型字符串，且仅当 ipProxySetting.type 为null时，ipProxySetting.host 可以为空字符串。
E10	ipProxySetting.port 【代理端口】不能超过 65535 !
E11	ipProxySetting.account 【代理账号】字符长度必须小于等于 200 个, 可以为空字符串 。
E12	ipProxySetting.password 【代理密码】字符长度必须小于等于 100 个, 可以为空字符串 。
E13	openUrlArray 【默认打开的链接】字符长度必须小于等于 200 个, 可以为空字符串 。
E14	notes 【备注】字符长度必须小于等于 20 个, 可以为空字符串 。
E15	马上就要超过窗口最大容量：200 个 了，请删除部分列表，然后重试！