Введение

Vision предоставляет возможность запуска и остановки профилей по API, используя HTTP-запросы. Для отправки некоторых запросов может потребоваться X-Token, подробнее о нём можно прочитать в соответствующей статье.

Получение токена авторизации

Получения токена авторизации для работы с API

Работа с профилями

Получение списка запущенных профилей

В Vision есть возможность получения информации по уже запущенным профилям.

Запрос

Для получения списка запущенных профилей необходимо отправить соответствующий GET запрос:

GET

http://localhost:3030/list

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

1const url =
2  "http://localhost:3030/list"; 
3
4const options = {
5  method: "GET",
6  headers: {
7    "X-Token": "Your Token", 
8  }, 
9};
10
11fetch(url, options)
12  .then((response) => {
13    response.json().then((data) => {
14      console.log(data);
15    });
16  })
17  .catch((error) => {
18    console.error(error);
19  });

Пример ответа

1{
2    "profiles": [
3        {
4            "folder_id": "698d2698-11a5-4768-bfb8-92b904026bfd",
5            "profile_id": "05296821-1ee5-445c-805f-1523578e898c",
6            "port": null
7        },
8        {
9            "folder_id": "698d2698-11a5-4768-bfb8-92b904026bfd",
10            "profile_id": "98bc0cb8-3cae-483f-bb8c-2607cc5c9883",
11            "port": null
12        },
13        {
14            "folder_id": "698d2698-11a5-4768-bfb8-92b904026bfd",
15            "profile_id": "9c6ed4a3-20b3-441d-adc6-58b99791f67b",
16            "port": null
17        }
18    ]
19}

Запуск профиля по API

Запрос

Для запуска профиля необходимо отправить соответствующий GET запрос:

Обратите внимание, что в URL запроса неободимо передать ID папки - folderId, в которой находится запускаемый профиль, а также ID самого профиля - profileID.

GET

http://localhost:3030/start/{folderId}/{profileId}

POST

http://localhost:3030/start/{folderId}/{profileId}

Если вы хотите передать дополнительные аргументы в браузер, вы можете сделать это, отправив POST запрос с JSON телом, содержащим поле args с массивом аргументов.

Заголовки запроса

Тело запроса (необязательно)

Array of extra arguments should be passed to browser

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

1const url =
2  "http://localhost:3030/start/{folderId}/{profileId}"; 
3
4const options = {
5  method: "GET",
6  headers: {
7    "X-Token": "Your Token", 
8  }, 
9};
10
11fetch(url, options)
12  .then((response) => {
13    response.json().then((data) => {
14      console.log(data);
15    });
16  })
17  .catch((error) => {
18    console.error(error);
19  });

Ответ

Данные ответа

ID папки, в которой находится запущенный профиль

profile_id

String

ID запущенного профиля

port

Number

Порт для подключения к профилю для автоматизации

Пример ответа

1{
2    "folder_id": "698d2698-11a5-4768-bfb8-92b904026bfd",
3    "profile_id": "98bc0cb8-3cae-483f-bb8c-2607cc5c9883",
4    "port": 19512
5}

Остановка профиля по API

Запрос

Для остановки профиля необходимо отправить соответствующий GET запрос:

GET

http://localhost:3030/stop/{folderId}/{profileId}

Обратите внимание, что в URL запроса неободимо передать ID папки - folderId, в которой находится останавливаемый профиль, а также ID самого профиля - profileId.

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

1const url =
2  "http://localhost:3030/stop/{folderId}/{profileId}"; 
3
4const options = {
5  method: "GET",
6  headers: {
7    "X-Token": "Your Token", 
8  }, 
9};
10
11fetch(url, options)
12  .then((response) => {
13    response.json().then((data) => {
14      console.log(data);
15    });
16  })
17  .catch((error) => {
18    console.error(error);
19  });

Ответ

Пример ответа

1Stopping profile 98bc0cb8-3cae-483f-bb8c-2607cc5c9883 in folder 698d2698-11a5-4768-bfb8-92b904026bfd

Авторизация Подключение к браузеру