Создание временного экземпляра браузера

Пожалуйста, ознакомьтесь с Правилами использования материалов на данном ресурсе.

Описание: Метод создаёт и запускает временный экземпляр браузера с одноразовым профилем. Профиль не добавляется в список профилей и удаляется вместе с данными после закрытия браузера. Чтобы остановить экземпляр, используйте метод удаления экземпляра браузера с profileId из ответа. Все параметры эмуляции необязательны.

Параметры запроса:

Parameter	Type	Format	Default	Description
workspaceId	integer	int64	-1	Идентификатор рабочего пространства. -1 означает рабочее пространство по умолчанию.
proxyServerId	string	uuid	(пусто)	Идентификатор прокси-сервера (необязательно).
desktopName	string		(пусто)	Имя среды рабочего стола.
environmentTags	string		(пусто)	Теги конфигурации окружения экземпляра браузера.
commandLineArguments	string		(пусто)	Пользовательские дополнительные аргументы командной строки, которые будут переданы браузеру при запуске.
customFeatures	string		(пусто)	JSON-объект с переопределениями функций браузера.
screen	string		(пусто)	Настройки конфигурации экрана. Допустимые значения: “auto” — использовать значение из отпечатка, “ignore” — использовать системное значение, либо “width x height” для задания пользовательского разрешения экрана (`auto`, `ignore` или ручной ввод разрешения, например SVGA, WSVGA, HD+ и т. д. Полный список разрешений, которые можно настроить вручную, приведен ниже) "SVGA" = 800×600; "0.69M3" = 960×720; "0.59M9" = 1024×576; "WSVGA" = 1024×600; "0.66MA" = 1024×640; "XGA" = 1024×768; "1152×648" = 1152×648; "XGA+" = 1152×864; "HD" = 1280×720; "WXGA" = 1280×768; "WXGA+" = 1280×800; "SXGA-" = 1280×960; "SXGA" = 1280×1024; "1360×768" = 1360×768; "WXGA HD" = 1366×768; "SXGA+" = 1400×1050; "WSXGA" = 1440×900; "1.56M3" = 1440×1080; "1536×864" = 1536×864; "HD+" = 1600×900; "UXGA" = 1600×1200; "WSXGA+" = 1680×1050; "1832×1392" = 1832×1392; "FHD" = 1920×1080; "WUXGA" = 1920×1200; "2.76M3" = 1920×1440; "QWXGA" = 2048×1152; "QXGA" = 2048×1536; "3.32MA" = 2304×1440; "WQHD" = 2560×1440; "WQXGA" = 2560×1600; "QSXGA" = 2560×2048; "5.18MA" = 2880×1800; "4K UHD-1" = 3840×2160; "9.44M9" = 4096×2304; "5K" = 5120×2880; "8K UHD-2" = 7680×4320;
cpu	string		(пусто)	Настройки конфигурации CPU. Допустимые значения: “auto” — использовать значение из отпечатка, “ignore” — использовать системное значение, либо целое число для задания пользовательского количества ядер процессора (`auto`, `ignore` или количество ядер ("2/4", "4/8", "6/12", "8/16", "10/20", "12/24", "14/28", "16/32", "32/64", "64/128"))
memory	string		(пусто)	Настройки конфигурации памяти. Допустимые значения: “auto” — использовать значение из отпечатка, “ignore” — использовать системное значение или целое число для указания собственного размера памяти (auto, ignore или размер памяти ("2", "4", "8", "16", "32", "64", "128"))
language	string		(пусто)	Настройки языка браузера. Допустимые значения: “auto” — использовать значение из отпечатка, “ignore” — использовать системное значение, либо значение языковой локали (`auto`, `ignore` или локаль: Russian - ru English (United States) - en-US German - de French - fr Spanish - es English (United Kingdom) - en-GB
geoLocation	string		(пусто)	Настройки географического положения. Допустимые значения: “auto” — использовать значение из отпечатка, “ignore” — использовать системное значение. Также можно указать от одного до семи чисел с плавающей запятой, которые представляют следующие геокоординаты: широта (Latitude), долгота (Longitude), высота (Altitude), точность (Accuracy), точность по высоте (AltitudeAccuracy), курс (Heading), скорость (Speed), радиус (Radius). Некоторые координаты можно пропускать. Например, следующая последовательность значений корректна: 10, , 40, , 60, 70 - означает Latitude = 10, Longitude = случайное значение, Altitude = 40, Accuracy = случайное значение, AltitudeAccuracy = 60, Heading = 70, Speed = случайное значение, Radius = случайное значение (`auto`, `ignore` или координаты (широта, долгота и т. д.))
timeZone	string		(пусто)	Настройки часового пояса. Допустимые значения: “auto” — использовать значение из отпечатка, “ignore” — использовать системное значение, либо пользовательское значение часового пояса (`auto`, `ignore` или конкретное значение (например, `Europe/Moscow`))
webGl	string		(пусто)	Настройки конфигурации WebGL. Допустимые значения: “auto” — использовать значение из отпечатка, “ignore” — использовать системное значение (`auto` или `ignore)`
webGpu	string		(пусто)	Настройки конфигурации WebGPU. Допустимые значения: “on” — включить или “off” — отключить эту функцию (`on` или `off)`
webRtc	string		(пусто)	Настройки конфигурации WebRTC. Допустимые значения: “Emulate” — использовать значение из отпечатка, “Real” — использовать системное значение или “Hide” — отключить эту функцию (`Emulate`, `Real` или `Hide)`
domRect	string		(пусто)	Настройки конфигурации DOM Rectangle. Допустимые значения: “Ignore” — отключить эту функцию или “Noise” — использовать зашумление dom rect (`Ignore` или `Noise)`
audio	string		(пусто)	Настройки конфигурации аудио. Допустимые значения: “on” — включить или “off” — отключить эту функцию (`on` или `off)`
fonts	string		(пусто)	Настройки конфигурации шрифтов. Допустимые значения: “on” — включить или “off” — отключить эту функцию `(on` или `off)`
battery	string		(пусто)	Настройки конфигурации батареи. Допустимые значения: “on” — включить или “off” — отключить эту функцию (`on` или `off)`
plugins	string		(пусто)	Настройки конфигурации плагинов браузера. Допустимые значения: “on” — включить или “off” — отключить эту функцию (`on` или `off)`
speechVoices	string		(пусто)	Настройки голосов синтеза речи. Допустимые значения: “on” — включить или “off” — отключить эту функцию (`on` или `off)`
canvas	string		(пусто)	Настройки Canvas. Допустимые значения: `Ignore` — отключить эту функцию или `Noise` — использовать зашумление.
mediaDevices	string		(пусто)	Настройки медиоустройств. Допустимые значения: `auto` — использовать значение из отпечатка, `ignore` — использовать реальные значения или пользовательские значения. Можно указать от одного до трех целых чисел, соответствующих значениям `AudioInput`, `AudioOutput` и `VideoInput`. Числа можно пропускать. Например, `1,,5` означает `AudioInput = 1`, `AudioOutput = случайное значение`, `VideoInput = 5`.
presetId	string	uuid	(пусто)	Необязательный идентификатор пресета, который используется для инициализации конфигурации профиля.
osVersion	string		(пусто)	Версия ОС для выбора отпечатка. Допустимые значения: `win10` или `win11`. Если значение не указано, сервер автоматически определяет ОС хоста.
imagesVideosDownload	string		(пусто)	Настройка загрузки изображений и видео. Допустимые значения: `on` — включить, `off` — отключить.
windowSizeFromFingerprint	string		(пусто)	Открывать окно браузера точно в разрешении экрана из отпечатка профиля. Допустимые значения: `on` — включить, `off` — отключить.

Пример запроса:

POST
CURL:

curl 'http://localhost:8160/v1/browser_instances/create_temporary?workspaceId=-1&proxyServerId=&desktopName=Desktop%201&environmentTags=&commandLineArguments=--disable-gpu&customFeatures=%7B%7D&screen=FHD&cpu=8%2F16&memory=8&language=en-US&geoLocation=auto&timeZone=Europe%2FMoscow&webGl=auto&webGpu=on&webRtc=Emulate&domRect=Noise&audio=on&fonts=on&battery=on&plugins=on&speechVoices=on&canvas=Noise&mediaDevices=1%2C1%2C1&presetId=&osVersion=win11&imagesVideosDownload=on&windowSizeFromFingerprint=on' \
  --request POST \
  --header 'Api-Token: YOUR_SECRET_TOKEN'

C#:

using System.Text;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("http://localhost:8160/v1/browser_instances/create_temporary?workspaceId=-1&screen=FHD&cpu=8%2F16&memory=8&language=en-US&timeZone=Europe%2FMoscow&osVersion=win11&windowSizeFromFingerprint=on"),
    Headers =
    {
        { "Api-Token", "YOUR_SECRET_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Cube:

http://localhost:8160/v1/browser_instances/create_temporary?workspaceId=-1&screen=FHD&cpu=8/16&memory=8&language=en-US&timeZone=Europe/Moscow&osVersion=win11&windowSizeFromFingerprint=on

Ответ API:

Код ответа	Результат
`200 OK`	Временный экземпляр браузера создан
`401 Unauthorized`	Не авторизован
`403 Forbidden`	Доступ запрещен
`500 Internal Server Error`	Внутренняя ошибка сервера

Успешный ответ (200 OK):

{
  "profileId": "123e4567-e89b-12d3-a456-426614174000",
  "processId": 1,
  "connectionString": null
}

Ответ с ошибкой (500):

{
  "message": null
}

Параметры запроса:​

Пример запроса:​

Ответ API:​

Параметры запроса:

Пример запроса:

Ответ API: