环境管理

1.1 启动浏览器环境

基本信息

接口描述：必须指定浏览器环境 ID 才能启动。成功启动浏览器环境后，即可获得用于selenium 和 puppeteer 自动化的配置文件调试界面。Selenium 需要使用与相应内核版本相匹配的 Webdriver。仅支持系统版本为 1.9.7.18 - 1.9.20.18 之间版本（目前仅支持 Windows 计算机）。

请求参数

Header parameters

主体参数、可选参数可以省略。

返回数据

{
    "ret": 0,
    "data": {
        "webdriver_url": "http://localhost:12345",   //webdriver路径
        "port": "12345"                              //自动化工具连接的浏览器调试接口
        "core_type": 0,
        "version": 112
    },
    "error": {
        "failure_code": 1,                           //错误码
        "biz_code": 10010,
        "client_code": 0,                            //网络状态: 1: 网络错误 -1: 程序异常
    }
}

错误码

1.2 检测浏览器环境状态

基本信息

接口描述：启动浏览器环境后，建议进行环境代理检测。如果跳过此步骤，您将无法确定当前浏览器配置文件内的网络环境，这可能会导致网络问题无法按预期运行。仅支持系统版本为 1.9.7.18 - 1.9.20.18 之间版本（目前仅支持Windows电脑）。

请求参数

Header parameters

主体参数，可选参数可以省略。

返回数据

Detection Successful
{
    "ret": 0,
    "data": {
        "status": 0,
        "ip": {
            "ip": "111.111.111.111",
            "status": 0,
            "msg": "Successful"
          }
    }
}
Detection Failed
{
    "ret": 1,
    "data": {
        "status": 2,
        "ip": {
            "ip": "Connection failure",
            "status": 2,
            "msg": "string"
    }
 }

1.3 关闭浏览器环境

基本信息

接口描述：关闭特定的浏览器环境，需要指定浏览器环境ID。仅支持系统版本为 1.9.7.18 - 1.9.20.18 之间版本（目前仅支持Windows电脑）。

请求参数

Header parameters

主体参数，可选参数可以省略。

返回数据

Successful
{
    "ret": 0
}
Failed
{
    "ret": 404,
    "error": 0,
    "msg": "string"
}

1.4 快速创建浏览器环境

基本信息

接口描述：快速创建浏览器环境。支持设置环境名称、浏览器、操作系统以及要创建的环境数量。创建成功后，API将返回环境ID。仅支持系统版本为 1.9.7.18 - 1.9.20.18 之间版本（目前仅支持Windows计算机）。

请求参数

Header parameters

主体参数，可选参数可以省略。参数格式为JSON。

返回数据

{
 "ret": 0,          //错误码
 "status": "0",
 "msg": "string",   //错误信息
 "data": {
     "ids": [
         0          //浏览器环境 ID 列表
      ]
    }
}

1.5 高级创建浏览器环境

基本信息

接口描述： 高级创建浏览器环境允许您为环境设置平台帐户凭据、cookie、指纹信息等。创建成功后，返回环境 ID。仅支持系统版本为 1.9.7.18 - 1.9.20.18 之间版本（目前仅支持Windows电脑）。

请求参数

Header parameters

主体参数，可选参数可以省略。

base_info

account_info

after_startup_config

advanced_setting

geolocation

port_scan_protection

after_startup_config

请求示例

{
    "base_info": {
        "name": "string",
        "default_browser": 0,
        "kernel_version": "string",
        "system_type": 0,
        "group_id": 0,
        "proxy_id": 0
    },
    "account_info": {
        "username": "string",
        "password": "string",
        "cookie": "string",
        "platform_name": "string",
        "custom_platform_url": "string",
        "after_startup_config": {
            "after_startup": 2,
            "auto_open_urls": [
                "string"
            ]
        }
    },
    "advanced_setting": {
        "ua": "string",
        "timezone": "string",
        "web_rtc": 3,
        "geolocation": {
            "type": 1,
            "location_follow_ip": "true",
            "longitude": "string",
            "lattitude": "string",
            "accuracy": "string"
        },
        "language_list": [
            "string"
        ],
        "resolution": "string",
        "font_list": [
            "string"
        ],
        "canvas": 1,
        "web_gl": {
            "type": 1,
            "metadata": 3
        },
        "audio_context": 1,
        "media_device": 1,
        "client_rects": 1,
        "speech_voices": 1,
        "concurrent_hardware_num": 4,
        "device_memory": 8,
        "do_not_track": 2,
        "bluetooth": 1,
        "battery": 1,
        "port_scan_protection": {
            "type": 1,
            "allow_ports": [
                0
            ]
        }
    }
}

返回数据

{
    "ret": 0,           //错误码
    "msg": "string",    //错误信息
    "data": {
        "id": 0         //浏览器环境 ID
    }
}

1.6 修改浏览器环境信息

基本信息

接口描述：若要修改浏览器环境参数，包括浏览器配置文件名称、代理信息、群组信息，仅支持系统版本为 1.9.7.18 - 1.9.20.18 之间版本（目前仅支持Windows计算机）。

请求参数

Header parameters

主体参数，可选参数可以省略。参数格式为JSON。

返回数据

{
    "ret": 0,             //错误码
    "status": "success",
    "msg": "string"       //错误信息
}

1.7 删除浏览器环境

基本信息

接口描述：删除不需要的浏览器配置文件。仅支持单次删除。仅支持系统版本为 1.9.7.18 - 1.9.20.18 之间版本（目前仅适用于Windows）。

请求参数

Header parameters

主体参数，可选参数可以省略。参数格式为JSON。

返回数据

{
    "ret": 0,            //错误码
    "status": "success",
    "data": [],
    "msg": "string"      //错误信息
}

1.8 获取浏览器环境列表

基本信息

接口描述：查询已添加的浏览器环境信息。用户只能查询自己有权限的浏览器环境信息。请仅支持系统版本为 1.9.7.18 - 1.9.20.18 之间版本（目前仅支持Windows电脑）。

请求参数

查询参数、可选参数可以省略。

Header parameters

返回数据

{
    "ret": 0,
    "msg": "string"
    "data": [                   //浏览器环境列表
        {
            "id": 0,            //浏览器环境ID
            "name": "string",   //浏览器环境名称
            "proxy_id": 0,      //浏览器环境绑定的代理 ID 
            "group_id": 0       //浏览器环境的分组 ID
            "default_browser": 0
        }
    ],
    "count": 0,                 //total count number
}

1.9 获取浏览器内核版本列表

基本信息

接口描述：获取浏览器内核版本，您可以在高级浏览器环境创建界面中使用此内核版本信息。仅支持系统版本为 1.9.7.18 - 1.9.20.18 之间版本（目前仅支持Windows电脑）。

Header parameters

查询参数。

返回数据

{
    "ret": 0,
    "msg": "string",
    "data": {                  //浏览器内核版本列表 
        "id": 0
    }
}