Справочник по HTTP API¶

HTTP API позволяет получить программный доступ ко многим функциям, доступным в вашем личном кабинете: управлять устройствами, создавать запланированные быстрые подключения для поддержки, получать историю подключений.

Запросы¶

Все запросы должны выполняться через протокол HTTPS (не HTTP) с использованием соответствующего метода для каждой команды по адресу https://api.pro32connect.ru/v1/.

Ответы¶

Ответы с данными возвращаются в формате JSON UTF-8 с заголовком ContentType: application/json. Каждый ответ содержит данные внутри data контейнера JSON.

Сервер API может возвращать следующие коды HTTP-ответов:

Код HTTP-ответа	Описание
`200 OK`	Запрос принят и обработан
`400 Bad Request`	Запрос отклонён: неверные параметры или ошибка
`402 Payment Required`	Запрос отклонён: превышен лимит запросов для тарифного плана
`403 Forbidden`	Запрос отклонён: нет доступа к данным
`404 Not Found`	Запрос отклонён: неизвестный URL запроса

Аутентификация¶

API является RESTful: сервер не хранит состояние подключения клиента. Поэтому клиент должен отправлять данные авторизации при каждом запросе. В качестве таких данных используется ключ API. Добавляйте ключ в каждом запросе в HTTP-заголовке X-Api-Key:

HTTPcURL

GET /
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -X GET "https://api.pro32connect.ru" \
-H "X-Api-Key: YOUR_API_KEY" \

Где получить API-ключ?

Ваш API-ключ можно найти в личном профиле в разделе Интеграция на вкладке HTTP API .

Методы¶

Это команды для управления устройствами и подключениями. Мы разделили их на несколько групп:

Постоянный доступ
Быстрая поддержка
История подключений
- Список подключений
- Информация о подключении

Постоянный доступ¶

Список компьютеров¶

Вы можете получить полный список компьютеров используя метод agents/list

Терминология

В контексте обращений к API компьютеры будут именоваться как Агенты, потому что в техническом отношении управление компьютером осуществляется через приложение Агент

Запрос:

HTTPcURL

GET /v1/agents/list
  ?search=<string>
  &group_id=<string>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -G "https://api.pro32connect.ru/v1/agents/list" \
  --data-urlencode "search=<string>" \
  --data-urlencode "group_id=<string>" \
  -H "X-Api-Key: YOUR_API_KEY" \

Параметр	Тип	Значение
`search`	`string`	Поиск по имени агента, IP-адресу или названию группы
`group_id`	`string`	Фильтр по идентификатору группы

Группировка устройств

Подробнее о работе с группами устройств см. в руководстве Группировка устройств.

Ответ:

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

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

{
    "data":[ {
        "id":1001,
        "name":"Allesandro Paci",
        "group":"Accounting",
        "disabled":false,
        "limited":false,
        "link_time":1587837997,
        "last_time":1600374761,
        "geo":{
            "ip":"94.242.23.99",
            "country":"Russia",
            "region":"St.-Petersburg",
            "city":"St Petersburg"
        },
        "permanent_url":"https://https://go.pro32connect.ru/paci",
        "preview_url":"https://pro32connect.ru/preview/1245273f5448a704379da46f476564a592efb17c6a7695adde96247cd7874416GbBzRm6SRLMqrP0YoYFMxCopL6NTzvn8.png",
        "os":"win",
        "version":"1.9.4",
        "online":true,
        "installed":true,
        "favorite":false,
        "owner":"john.smith@gmail.com",
        "sessions":{
            "last":{
                "id":148505,
                "start_time":1600343858,
                "stop_time":1600343900,
                "client":{
                    "ip":"188.162.195.82",
                    "country":"Russian Federation",
                    "region":"Tatarstan",
                    "city":"Kazan",
                    "user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 Safari/537.36"
                }
            },
            "total":121
        }
    }, ... ]
}

Название	Тип	Описание
`id`	`number`	Внутрисистемный идентификатор
`device_id`	`number`	Публичный идентификатор агента
`name`	`string`	Название
`group`	`string`	Группа
`disabled`	`boolean`	Агент заблокирован? К заблокированным агентам подключится нельзя. Блокировка наступает в случае превышения лимита по количеству компьютеров в тарифного плана.
`limited`	`boolean`	Агент лимитирован? Агент становится лимитированным в случае превышения лимита тарифного плана по количестсву прикрепленных файлов. Через 10 дней после добавления лимитированный агент становится заблокированным.
`link_time`	`unixtime`	Дата и время добавления в личный кабинет
`last_time`	`unixtime`	Дата и время последнего состояния «В сети»
`geo`	`object`	Гео-расположение
`geo.ip`	`string`	IP адрес
`geo.country`	`string`	Страна
`geo.region`	`string`	Регион
`geo.city`	`string`	Город
`permanent_url`	`string`	Постоянный URL-адрес для подключения Поле может отсутствовать, если доступ для неавторизованных техников закрыт
`onetime_url`	`string`	URL-адрес для одноразового подключения Ссылка меняется каждые 45 секунд Поле может отсутствовать, если подключения по одноразовым ссылкам запрещены в настройках агента
`preview_url`	`string`	URL-адрес для загрузки превью рабочего стола
`os`	`string`	Операционная система. Возможные значения: `win`, `mac`, `linux` и `android`
`os_user`	`string`	Пользователь ОС
`rdp`	`bool`	Поддержка RDP
`hibernate`	`bool`	Режим сна
`power_supply`	`bool`	Питание
`version`	`string`	Версия агента
`online`	`boolean`	Текущее состояние «В сети»
`installed`	`boolean`	Агент установлен на компьютере?
`favorite`	`boolean`	Это избранный компьютер в списке в личном кабинете?
`owner`	`string`	Учетная запись владельца доступа к компьютеру внутри системы
`sessions`	`object`	Информация о подключениях
`sessions.last`	`object`	Последнее подключение
`sessions.last.id`	`number`	Внутри-системный идентификатор подключения
`sessions.last.start_time`	`unixtime`	Дата и время начала подключения
`sessions.last.stop_time`	`unixtime`	Дата и время конца подключения Поле может отсутствовать, если подключение активно
`sessions.last.client`	`object`	Информация о клиенте (автор подключения)
`sessions.last.client.ip`	`string`	IP-адрес
`sessions.last.client.country`	`string`	Страна
`sessions.last.client.region`	`string`	Регион
`sessions.last.client.city`	`string`	Город
`sessions.last.client.user_agent`	`string`	Пользовательский агент браузера клиента
`sessions.total`	`object`	Общее количество подключений

Информация об устройстве¶

Чтобы получить информацию об устройстве из раздела Постоянный доступ, используйте метод agents/info:

Запрос:

HTTPcURL

GET /v1/agents/info
  &agent_id=<number>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -G "https://api.pro32connect.ru/v1/agents/info" \
  --data-urlencode "agent_id=<number>" \
  -H "X-Api-Key: YOUR_API_KEY" \

Параметр	Тип	Значение
`agent_id`	`number`	Внутрисистемный идентификатор агента

Ответ:

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

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

{
    "data": {
        "id": 1001,
        "name": "Allesandro Paci",
        "group": "Accounting",
        "disabled": false,
        "limited": false,
        "link_time": 1587837997,
        "last_time": 1600374761,
        "geo": {
            "ip": "94.242.23.99",
            "country": "Russia",
            "region": "St.-Petersburg",
            "city": "St Petersburg"
        },
        "permanent_url": "https://https://go.pro32connect.ru/paci",
        "onetime_url": "https://https://go.pro32connect.ru/am2-l2g",
        "preview_url": "https://pro32connect.ru/preview/1245273f5448a704379da46f476564a592efb17c6a7695adde96247cd7874416GbBzRm6SRLMqrP0YoYFMxCopL6NTzvn8.png",
        "os": "win",
        "version": "2.7.6",
        "online": true,
        "installed": true,
        "favorite": false,
        "owner": "john.smith@gmail.com",
        "hardware": {
            "BIOS": "ALASKA - 1072009 - F51 - American Megatrends - 5000E",
            "BIOSDate": "",
            "BIOSVersion": "20191218",
            "CPU": "AMD Ryzen 5 2600X Six-Core Processor",
            "CPUCores": 6,
            "CPUCoresLogical": 12,
            "CPUFamily": "AMD64 Family 23 Model 8 Stepping 2",
            "CPUSpeed": 3600,
            "ComputerDomain": "WORKGROUP",
            "ComputerIP": [
                "10.66.65.3",
                "fe80::35da:bb0:c661:fff9"
            ],
            "ComputerModel": "B450 AORUS ELITE",
            "ComputerName": "DESKTOP-AU0VQEE",
            "ComputerWorkgroup": "WORKGROUP",
            "HDD": [ {
                "Model": "INTEL SSDPEKNW512G8",
                "Size": 488382
            } ],
            "Locale": "0419",
            "LocaleCountry": "Russia",
            "LocaleCurrency": "USD",
            "LocaleFormatDate": "MM-DD-YYYY",
            "LocaleFormatTime": "H:mm:ss",
            "LocaleOemPage": "437",
            "LocaleTimezone": -420,
            "LogicalDisks": [ {
                "Disk": "C:",
                "FileSystem": "NTFS",
                "FreeSpace": 13668,
                "Name": "",
                "Size": 487757
            } ],
            "Monitors": [ {
                "Name": "Universal PnP monitor",
                "ScreenHeight": 1080,
                "ScreenWidth": 1920
            } ],
            "NetAdapters": [ {
                "Addresses": "",
                "Cable": true,
                "DCHP": "",
                "DNS": "",
                "MACAddress": "18:C0:4D:44:F0:61",
                "Manufacturer": "Realtek",
                "Name": "Realtek Gaming GbE Family Controller",
                "Speed": 953,
                "WoL": true
            } ],
            "OSName": "Microsoft Windows 10 Pro",
            "OSVersion": "10.0.19044",
            "RAMBanks": [ {
                "Bank": "P0 CHANNEL A",
                "Capacity": 8192,
                "DataWidth": 64,
                "Locator": "DIMM 0",
                "Manufacturer": "Unknown",
                "PartNumber": "F4-3200C16-8GSXFB",
                "SerialNumber": "00000000"
            } ],
            "RAMPageFile": 51264,
            "RAMPhys": 32716,
            "RAMPhysAvail": 9380,
            "RAMVirt": 134217727,
            "RAMVirtAvail": 134213282,
            "SoundDevices": [ {
                "Name": "NVIDIA High Definition Audio"
            } ],
            "VideoCards": [ {
                "Integrated": true,
                "Name": "NVIDIA GeForce GT 710",
                "RAM": 1024
            } ],
            "VideoName": "NVIDIA GeForce GT 710",
            "VideoRAM": 1024
        },
        "sessions": {
            "last": {
                "id":148505,
                "start_time":1600343858,
                "stop_time":1600343900,
                "client":{
                    "ip":"188.162.195.82",
                    "country":"Russian Federation",
                    "region":"Tatarstan",
                    "city":"Kazan",
                    "user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 Safari/537.36"
                }
            },
            "total": 1
        }
    }
}

Название	Тип	Описание
`id`	`number`	Внутрисистемный идентификатор
`device_id`	`number`	Публичный идентификатор агента
`name`	`string`	Название
`group`	`string`	Группа
`disabled`	`boolean`	Агент заблокирован? К заблокированным агентам подключится нельзя. Блокировка наступает в случае превышения лимита по количеству компьютеров в тарифного плана.
`limited`	`boolean`	Агент лимитирован? Агент становится лимитированным в случае превышения лимита тарифного плана по количестсву прикрепленных файлов. Через 10 дней после добавления лимитированный агент становится заблокированным.
`link_time`	`unixtime`	Дата и время добавления в личный кабинет
`last_time`	`unixtime`	Дата и время последнего состояния «В сети»
`geo`	`object`	Гео-расположение
`geo.ip`	`string`	IP адрес
`geo.country`	`string`	Страна
`geo.region`	`string`	Регион
`geo.city`	`string`	Город
`permanent_url`	`string`	Постоянный URL-адрес для подключения Поле может отсутствовать, если доступ для неавторизованных техников закрыт
`onetime_url`	`string`	URL-адрес для одноразового подключения Ссылка меняется каждые 45 секунд Поле может отсутствовать, если подключения по одноразовым ссылкам запрещены в настройках агента
`preview_url`	`string`	URL-адрес для загрузки превью рабочего стола
`os`	`string`	Операционная система. Возможные значения: `win`, `mac`, `linux` и `android`
`os_user`	`string`	Пользователь ОС
`rdp`	`bool`	Поддержка RDP
`hibernate`	`bool`	Режим сна
`power_supply`	`bool`	Питание
`version`	`string`	Версия агента
`online`	`boolean`	Текущее состояние «В сети»
`installed`	`boolean`	Агент установлен на компьютере?
`favorite`	`boolean`	Это избранный компьютер в списке в личном кабинете?
`owner`	`string`	Учетная запись владельца доступа к компьютеру внутри системы
`hardware`	`object`	Информация о системе
`hardware.BIOS`	`string`	Информация о BIOS
`hardware.BIOSDate`	`string`	Дата обновления
`hardware.BIOSVersion`	`string`	Версия
`hardware.CPU`	`string`	Процессор
`hardware.CPUCores`	`number`	Количество ядер
`hardware.CPUCoresLogical`	`number`	Количество логических процессоров
`hardware.CPUFamily`	`string`	Семейство
`hardware.CPUSpeed`	`number`	Скорость
`hardware.ComputerDomain`	`string`	Домен
`hardware.ComputerIP`	`array`	IP-адрес
`hardware.ComputerModel`	`string`	Модель
`hardware.ComputerName`	`string`	Имя компьютера
`hardware.ComputerWorkgroup`	`string`	Рабочая группа
`hardware.HDD`	`array`	Жесткие диски
`hardware.HDD[].Model`	`string`	Модель
`hardware.HDD[].Size`	`number`	Размер
`hardware.Locale`	`string`	Локаль
`hardware.LocaleCountry`	`string`	Страна
`hardware.LocaleCurrency`	`string`	Валюта
`hardware.LocaleFormatDate`	`string`	Формат даты
`hardware.LocaleFormatTime`	`string`	Формат времени
`hardware.LocaleOemPage`	`string`	Кодировка страниц
`hardware.LocaleTimezone`	`number`	Таймзона
`hardware.LogicalDisks`	`array`	Логические диски
`hardware.LogicalDisks[].Disk`	`string`	Метка
`hardware.LogicalDisks[].FileSystem`	`string`	Тип файловой системы
`hardware.LogicalDisks[].FreeSpace`	`number`	Свободное место (МБ)
`hardware.LogicalDisks[].Name`	`string`	Название
`hardware.LogicalDisks[].Size`	`number`	Размер (МБ)
`hardware.Monitors`	`array`	Мониторы
`hardware.Monitors[].Name`	`string`	Название
`hardware.Monitors[].ScreenHeight`	`number`	Высота экрана
`hardware.Monitors[].ScreenWidth`	`number`	Ширина экрана
`hardware.NetAdapters`	`array`	Сетевые карты
`hardware.NetAdapters[].Addresses`	`string`	Адрес
`hardware.NetAdapters[].Cable`	`boolean`	Подключение в интернет по LAN-кабелю
`hardware.NetAdapters[].DCHP`	`string`	DCHP
`hardware.NetAdapters[].DNS`	`string`	DNS
`hardware.NetAdapters[].MACAddress`	`string`	MAC-адрес
`hardware.NetAdapters[].Manufacturer`	`string`	Производитель
`hardware.NetAdapters[].Name`	`string`	Название
`hardware.NetAdapters[].Speed`	`number`	Скорость
`hardware.NetAdapters[].WoL`	`boolean`	Включена настройка Wake-on-LAN
`hardware.OSName`	`string`	Название операционной системы
`hardware.OSVersion`	`string`	Версия операционной системы
`hardware.RAMBanks`	`array`	Память ОЗУ
`hardware.RAMBanks[].Bank`	`string`	Слот
`hardware.RAMBanks[].Capacity`	`number`	Емкость
`hardware.RAMBanks[].Locator`	`string`	Локатор
`hardware.RAMBanks[].Manufacturer`	`string`	Производитель
`hardware.RAMBanks[].PartNumber`	`string`	Партия
`hardware.RAMBanks[].SerialNumber`	`string`	Серия
`hardware.RAMPageFile`	`number`	Размер файла подкачки
`hardware.RAMPhys`	`number`	Общий объём физической оперативной памяти
`hardware.RAMPhysAvail`	`number`	Значение объёма свободной физической оперативной памяти
`hardware.RAMVirt`	`number`	Общий объём виртуальной памяти
`hardware.RAMVirtAvail`	`number`	Объём доступной виртуальной памяти
`hardware.SoundDevices`	`array`	Звуковые карты
`hardware.SoundDevices[].Name`	`string`	Название
`hardware.VideoCards`	`array`	Видео-карта
`hardware.VideoCards[].Integrated`	`boolean`	Интегрированная
`hardware.VideoCards[].Name`	`string`	Название
`hardware.VideoCards[].RAM`	`number`	Память
`sessions`	`object`	Информация о подключениях
`sessions.last`	`object`	Последнее подключение
`sessions.last.id`	`number`	Внутри-системный идентификатор подключения
`sessions.last.start_time`	`unixtime`	Дата и время начала подключения
`sessions.last.stop_time`	`unixtime`	Дата и время конца подключения Поле может отсутствовать, если подключение активно
`sessions.last.client`	`object`	Информация о клиенте (автор подключения)
`sessions.last.client.ip`	`string`	IP-адрес
`sessions.last.client.country`	`string`	Страна
`sessions.last.client.region`	`string`	Регион
`sessions.last.client.city`	`string`	Город
`sessions.last.client.user_agent`	`string`	Пользовательский агент браузера клиента
`sessions.total`	`object`	Общее количество подключений

Изменение свойства устройства¶

Чтобы изменить какое-либо свойство устройства, привязанного к вашей учетной записи, вы можете использовать метод agents/update.

Необязательные поля

Вам не обязательно указывать все свойства в запросе. Будут изменены только те, которые вы зададите. Список полей, доступных для обновления, см. ниже в параметрах.

Request:

HTTPcURL

POST /v1/agents/update
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "id": <number>,
  "permanent_url": {
    "enable": <boolean>,
    "url": <string>,
    "password": <string>
  }
}

curl -X POST "https://api.pro32connect.ru/v1/agents/update" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>,
    "permanent_url": {
      "enable": <boolean>,
      "url": "<string>",
      "password": "<string>"
    }
  }'

Параметр	Тип	Значение
`id`	`number`	Внутрисистемный идентификатор агента
`name`	`string`	Имя устройства
`permanent_url`	`object`	Постоянная ссылка для подключения
`permanent_url.enable`	`boolean`	Включить/выключить
`permanent_url.url`	`string`	Путь ссылки
`permanent_url.password`	`string`	Пароль для подключения (не меньше 8 символов, обязательно буквы и цифры)

Ответ:

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

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

{
    "status": 0,
    "data": {
        "id": 1001,
        "name": "Allesandro Paci",
        "group": "Accounting",
        "disabled": false,
        "limited": false,
        "link_time": 1587837997,
        "last_time": 1600374761,
        "geo": {
            "ip": "94.242.23.99",
            "country": "Russia",
            "region": "St.-Petersburg",
            "city": "St Petersburg"
        },
        "permanent_url": "https://https://go.pro32connect.ru/paci",
        "onetime_url": "https://https://go.pro32connect.ru/am2-l2g",
        "preview_url": "https://pro32connect.ru/preview/1245273f5448a704379da46f476564a592efb17c6a7695adde96247cd7874416GbBzRm6SRLMqrP0YoYFMxCopL6NTzvn8.png",
        "os": "win",
        "version": "2.7.6",
        "online": true,
        "installed": true,
        "favorite": false,
        "owner": "john.smith@gmail.com",
        "hardware": {
            "BIOS": "ALASKA - 1072009 - F51 - American Megatrends - 5000E",
            "BIOSDate": "",
            "BIOSVersion": "20191218",
            "CPU": "AMD Ryzen 5 2600X Six-Core Processor",
            "CPUCores": 6,
            "CPUCoresLogical": 12,
            "CPUFamily": "AMD64 Family 23 Model 8 Stepping 2",
            "CPUSpeed": 3600,
            "ComputerDomain": "WORKGROUP",
            "ComputerIP": [
                "10.66.65.3",
                "fe80::35da:bb0:c661:fff9"
            ],
            "ComputerModel": "B450 AORUS ELITE",
            "ComputerName": "DESKTOP-AU0VQEE",
            "ComputerWorkgroup": "WORKGROUP",
            "HDD": [ {
                "Model": "INTEL SSDPEKNW512G8",
                "Size": 488382
            } ],
            "Locale": "0419",
            "LocaleCountry": "Russia",
            "LocaleCurrency": "USD",
            "LocaleFormatDate": "MM-DD-YYYY",
            "LocaleFormatTime": "H:mm:ss",
            "LocaleOemPage": "437",
            "LocaleTimezone": -420,
            "LogicalDisks": [ {
                "Disk": "C:",
                "FileSystem": "NTFS",
                "FreeSpace": 13668,
                "Name": "",
                "Size": 487757
            } ],
            "Monitors": [ {
                "Name": "Universal PnP monitor",
                "ScreenHeight": 1080,
                "ScreenWidth": 1920
            } ],
            "NetAdapters": [ {
                "Addresses": "",
                "Cable": true,
                "DCHP": "",
                "DNS": "",
                "MACAddress": "18:C0:4D:44:F0:61",
                "Manufacturer": "Realtek",
                "Name": "Realtek Gaming GbE Family Controller",
                "Speed": 953,
                "WoL": true
            } ],
            "OSName": "Microsoft Windows 10 Pro",
            "OSVersion": "10.0.19044",
            "RAMBanks": [ {
                "Bank": "P0 CHANNEL A",
                "Capacity": 8192,
                "DataWidth": 64,
                "Locator": "DIMM 0",
                "Manufacturer": "Unknown",
                "PartNumber": "F4-3200C16-8GSXFB",
                "SerialNumber": "00000000"
            } ],
            "RAMPageFile": 51264,
            "RAMPhys": 32716,
            "RAMPhysAvail": 9380,
            "RAMVirt": 134217727,
            "RAMVirtAvail": 134213282,
            "SoundDevices": [ {
                "Name": "NVIDIA High Definition Audio"
            } ],
            "VideoCards": [ {
                "Integrated": true,
                "Name": "NVIDIA GeForce GT 710",
                "RAM": 1024
            } ],
            "VideoName": "NVIDIA GeForce GT 710",
            "VideoRAM": 1024
        },
        "sessions": {
            "last": {
                "id":148505,
                "start_time":1600343858,
                "stop_time":1600343900,
                "client":{
                    "ip":"188.162.195.82",
                    "country":"Russian Federation",
                    "region":"Tatarstan",
                    "city":"Kazan",
                    "user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 Safari/537.36"
                }
            },
            "total": 1
        }
    }
}

Название	Тип	Описание
`number`	`status`	Статус результата. Возможные значения: `0` - Данные успешно сохранены `1` - Некорректный запрос `7` - Путь для постоянной ссылки занят `8` - Изменение свойств запрещено `21` - Невалидный пароль для постоянной ссылки
`data`	`object`	Те же данные, что и в ответе метода Изменение свойства устройства

Добавление кнопки подключения в панель управления

Узнайте, как интегрировать ссылку для подключения в вашу систему, в руководстве Интеграция удалённого доступа в вашу систему.

Получить ссылку для подключения¶

Чтобы подключиться к компьютеру через API вам необходимо получить одноразовую ссылку, используя метод agents/connect

Время действия ссылки

Ссылка истекает сразу после первого использования. Вам необходимо получать новую ссылку каждый раз, когда вы хотите подключиться.

Запрос:

HTTPcURL

POST /v1/agents/connect
  ?agent_id=<number>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -X POST "https://api.pro32connect.ru/v1/agents/connect?agent_id=<number>" \
  -H "X-Api-Key: YOUR_API_KEY"

Параметр	Тип	Значение
`agent_id`	`number`	Внутрисистемный идентификатор агента
`device_id`	`number`	Публичный идентификатор агента. Доступен в карточке агента в личном кабинете. Используется, если параметр `agent_id` не указан.
`video`	`boolean`	Возможные значение: `true` - включено автоматическое ведение видео-записи `false` - выключено автоматическое ведение видео-записи

Ответ:

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

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

{
    "data":{
        "url": "https://https://go.pro32connect.ru/john.smith/?connect=20177&amp;llt=66b4kj671pm3abpp5xh17elpnpze245382m9pxbrx313l2xp52hmxqe4e1dekpej&amp;s=c2c5ca25eb4fca787b74a97648e0856951e2b9c7aa02cbf83ac62c81e21a9bab"
    }
}

Название	Тип	Описание
`url`	`string`	URL-адрес для подключения

Добавление кнопки подключения в панель управления

Узнайте, как интегрировать ссылку для подключения в вашу систему, в руководстве Интеграция удалённого доступа в вашу систему.

Перезагрузка устройства¶

Чтобы отправить запрос на перезагрузку устройства, необходимо использовать метод /agents/reboot.

Запрос:

HTTPcURL

POST /v1/agents/reboot
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "id": <number>
  "safe": <boolean>
}

curl -X POST "https://api.pro32connect.ru/v1/agents/reboot" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>,
    "safe": <boolean>
  }'

Параметр	Тип	Значение
`id`	`number`	Внутрисистемный идентификатор агента
`safe`	`boolean`	Возможные значения: `true` - перезагрузка в безопасном режиме `false` - перезагрузка в обычном режиме

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

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

{
    "status": 0,
}

Название	Тип	Описание
`number`	`status`	Статус результата. Возможные значения: `0` - Запрос принят `1` - Недопустимый запрос

Доступность

Проверьте, какие типы агентов поддерживают функцию перезагрузки, в руководстве Функции управления экраном.

Пробуждение устройства¶

Чтобы отправить запрос на пробуждение устройства с использованием функции Wake-on-LAN, вы можете использовать запрос agents/wake.

Подготовка устройства

Для работы этой функции требуется предварительная настройка устройств с поддержкой пробуждения. Подробнее см. в руководстве Как настроить Wake-on-LAN?.

Запрос:

HTTPcURL

POST /v1/agents/wake
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
"id": <number>
}

curl -X POST "https://api.pro32connect.ru/v1/agents/wake" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>
  }'

Параметр	Тип	Значение
`id`	`number`	Внутренний системный идентификатор агента

Ответ:

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

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

{
    "status": 0,
}

Имя	Тип	Описание
`status`	`number`	Статус результата. Возможные значения: `0` — запрос принят `1` — неверный запрос

Выход устройства из системы¶

Чтобы отвязать устройство от вашей учетной записи и удалить его из постоянного доступа, используйте метод agents/logout.

Будьте осторожны!

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

Запрос:

HTTPcURL

POST /v1/agents/logout
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "id": <number>
}

curl -X POST "https://api.pro32connect.ru/v1/agents/logout" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>
  }'

Параметр	Тип	Значение
`id`	`number`	Внутрисистемный идентификатор агента

Ответ:

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

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

{
    "status": 0
}

Название	Тип	Описание
`number`	`status`	Статус результата. Возможные значения: `0` - Выход устройства выполнен успешно `1` - Некорретный запрос `6` - Устройство не найдено `8` - Операция запрещена

Быстрая поддержка¶

Список приглашений¶

Чтобы получить список открытых приглашений из раздела Быстрая поддержка, используйте метод support/list.

Запрос:

HTTPcURL

GET /v1/support/list
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl "https://api.pro32connect.ru/v1/support/list" \
  -H "X-Api-Key: YOUR_API_KEY"

Параметры отсутствуют.

Ответ:

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

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

{
    "remain":100,
    "data":[ {
        "id":328,
        "status":0,
        "create_time":1600262268,
        "invite_code":"408080316",
        "invite_url":"https://https://go.pro32connect.ru/invite/408080316",
        "connect_url":"https://https://go.pro32connect.ru/turbo/nrhaStVwQSQ1J4DW0cL4wc1ADUeyug8BZjFaCgEqT4wuFXSPXQrGoRRBUxK1uFTU1Sr7bYlsviZ0djTophpmnIhpaZuMfGSKdSefcDzOWCgJuGeHGA5hFkcflhAXhBrx",
        "client_name":"Jacob Williams",
        "client_os":"",
        "client_preview_url":""
    } ]
}

Данные записи подключения:

Название	Тип	Значение
`id`	`number`	Внутрисистемный идентификатор подключения
`status`	`number`	Статус подключения. Возможные значения: `0` - Новое подключение, ожидается присоединение клиента `1` - Клиент подключился, ожидается присоединение оператора `2` - Активное подключение, все участники присоединились `3` - Закрытое подключения
`create_time`	`unixtime`	Дата и время создания подключения
`invite_code`	`string`	Код для приглашения
`invite_url`	`string`	URL-адрес для приглашения
`connect_url`	`string`	URL-адрес для присоединения оператора к подключению
`client_name`	`string`	Имя клиента
`client_os`	`string`	Операционная система. Возможные значения: `win`, `mac`, `linux` и `android` Поле заполняется после присоединения клиента
`client_preview_url`	`string`	Миниатюра изображения рабочего стола клиента Поле заполняется после присоединения клиента

Дополнительная информация:

Название	Тип	Значение
`remain`	`number`	Количество оставшихся подключений в рамках тарифного плана

Создание приглашения¶

Чтобы создать приглашение и запланированное подключение для Быстрой поддержки, используйте метод support/create.

Запрос:

HTTPcURL

POST /v1/support/create
  ?client_name=<string>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -X POST -G "https://api.pro32connect.ru/v1/support/create" \
  --data-urlencode "client_name=<string>" \
  -H "X-Api-Key: YOUR_API_KEY"

Параметр	Тип	Значение
`client_name`	`string`	Имя клиента (видно только вам). Необязательный параметр.

Ответ:

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

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

{
    "data":{
        "id":328,
        "status":0,
        "create_time":1600262268,
        "invite_code":"408080316",
        "invite_url":"https://https://go.pro32connect.ru/invite/408080316",
        "connect_url":"https://https://go.pro32connect.ru/turbo/nrhaStVwQSQ1J4DW0cL4wc1ADUeyug8BZjFaCgEqT4wuFXSPXQrGoRRBUxK1uFTU1Sr7bYlsviZ0djTophpmnIhpaZuMfGSKdSefcDzOWCgJuGeHGA5hFkcflhAXhBrx",
        "client_name":"Jacob Williams",
        "client_os":"",
        "client_preview_url":""
    }
}

Название	Тип	Значение
`id`	`number`	Внутрисистемный идентификатор подключения
`status`	`number`	Статус подключения. Возможные значения: `0` - Новое подключение, ожидается присоединение клиента `1` - Клиент подключился, ожидается присоединение оператора `2` - Активное подключение, все участники присоединились `3` - Закрытое подключения
`create_time`	`unixtime`	Дата и время создания подключения
`invite_code`	`string`	Код для приглашения
`invite_url`	`string`	URL-адрес для приглашения
`connect_url`	`string`	URL-адрес для присоединения оператора к подключению
`client_name`	`string`	Имя клиента
`client_os`	`string`	Операционная система. Возможные значения: `win`, `mac`, `linux` и `android` Поле заполняется после присоединения клиента
`client_preview_url`	`string`	Миниатюра изображения рабочего стола клиента Поле заполняется после присоединения клиента

Информация о приглашении¶

Чтобы получить информацию о конкретном приглашении, используйте метод support/info.

Запрос:

HTTPcURL

GET /v1/support/info
  ?connection_id=<number>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -G "https://api.pro32connect.ru/v1/support/info" \
  --data-urlencode "connection_id=<number>" \
  -H "X-Api-Key: YOUR_API_KEY" \

Параметр	Тип	Значение
`connection_id`	`number`	Внутренний ID приглашения в системе

Ответ:

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

```json title="Данные ответа" { "data":{ "id":328, "status":2, "create_time":1600262268, "invite_code":"408080316", "invite_url":"https://https://go.pro32connect.ru/invite/408080316", "connect_url":"https://https://go.pro32connect.ru/turbo/nrhaStVwQSQ1J4DW0cL4wc1ADUeyug8BZjFaCgEqT4wuFXSPXQrGoRRBUxK1uFTU1Sr7bYlsviZ0djTophpmnIhpaZuMfGSKdSefcDzOWCgJuGeHGA5hFkcflhAXhBrx", "client_name":"Jacob Williams", "client_os":"win", "client_preview_url":"https://pro32connect.ru/preview/f90d07668bccd418a5a8_

Название	Тип	Значение
`id`	`number`	Внутрисистемный идентификатор подключения
`status`	`number`	Статус подключения. Возможные значения: `0` - Новое подключение, ожидается присоединение клиента `1` - Клиент подключился, ожидается присоединение оператора `2` - Активное подключение, все участники присоединились `3` - Закрытое подключения
`create_time`	`unixtime`	Дата и время создания подключения
`invite_code`	`string`	Код для приглашения
`invite_url`	`string`	URL-адрес для приглашения
`connect_url`	`string`	URL-адрес для присоединения оператора к подключению
`client_name`	`string`	Имя клиента
`client_os`	`string`	Операционная система. Возможные значения: `win`, `mac`, `linux` и `android` Поле заполняется после присоединения клиента
`client_preview_url`	`string`	Миниатюра изображения рабочего стола клиента Поле заполняется после присоединения клиента

Закрытие приглашения¶

Чтобы закрыть приглашение, используйте метод support/close.

Запрос:

HTTPcURL

POST /v1/support/close
  ?connection_id=<number>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -X POST -G "https://api.pro32connect.ru/v1/support/close" \
  --data-urlencode "connection_id=<number>" \
  -H "X-Api-Key: YOUR_API_KEY"

Параметр	Тип	Значение
`connection_id`	`number`	Внутренний ID приглашения в системе

Ответ:

Ответ будет пустым. Для анализа выполнения команды используйте только HTTP код ответа.

История подключений¶

Список сессий¶

Чтобы получить историю ваших подключений, используйте метод history/list.

Запрос:

HTTPcURL

GET /v1/history/list
  ?agent_id=<number>
  &support_id=<number>
  &date_from=<unixtime>
  &date_to=<unixtime>
  &video=<boolean>
  &offset=<number>
  &limit=<number>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -G "https://api.pro32connect.ru/v1/history/list" \
  --data-urlencode "agent_id=<number>" \
  --data-urlencode "support_id=<number>" \
  --data-urlencode "date_from=<unixtime>" \
  --data-urlencode "date_to=<unixtime>" \
  --data-urlencode "video=<boolean>" \
  --data-urlencode "offset=<number>" \
  --data-urlencode "limit=<number>" \
  -H "X-Api-Key: YOUR_API_KEY" \

Параметр	Тип	Значение
`agent_id`	`string`	Фильтр по ID агента
`support_id`	`number`	Фильтр по ID приглашения
`date_from`	`unixtime`	Фильтр по дате и времени: начало периода
`date_to`	`unixtime`	Фильтр по дате и времени: конец периода
`video`	`boolean`	Фильтр по записи видео
`offset`	`number`	Смещение для первого элемента в списке
`limit`	`number`	Количество элементов в списке. Значение по умолчанию: `20`; максимальное значение: `100`

Ответ:

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

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

{
    "offset": 0,
    "limit": 10,
    "total": 15,
    "filter": {
        "date_from": 1608660281,
        "date_to": 1608660389,
        "agent_id": 1001,
        "support_id": 1002,
        "video": true
    },
    "data": [ {
        "id": 27233,
        "start": 1608660273,
        "stop": 1608660281,
        "support_id": 1002,
        "client": [ {
            "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
            "login": "john.smith@gmail.com",
            "geo": {
                "ip": "94.242.23.99",
                "country": "Russia",
                "region": "St.-Petersburg",
                "city": "St Petersburg"
            }
        } ],
        "agent": {
            "id": 1001,
            "name": "DESKTOP-SJBU5PO",
            "group": "Accounting",
            "geo": {
                "ip": "94.242.23.99",
                "country": "Russia",
                "region": "St.-Petersburg",
                "city": "St Petersburg"
            },
            "os": "win",
            "version": "2.1.5",
            "owner": "john.smith@gmail.com"
        },
        "video": {
            "url": "https://st.pro32connect.ru/video/2/27233.mp4",
            "size": 428652
        }
    }, ... ]
}

Имя	Тип	Описание
`id`	`number`	Внутренний ID подключения в системе
`start`	`unixtime`	Дата и время начала подключения
`stop`	`unixtime`	Дата и время окончания подключения Может быть пустым, если подключение не завершено
`support_id`	`number`	ID подключения по приглашению Поле может быть пустым, если подключение было к устройству с постоянным доступом
`client`	`array`	Список клиентов, присоединившихся к подключению
`client[].user_agent`	`string`	User agent
`client[].login`	`string`	Логин клиента Может быть пустым, если подключение было анонимным
`client[].geo`	`object`	Местоположение
`client[].geo.ip`	`string`	IP-адрес
`client[].geo.country`	`string`	Страна
`client[].geo.region`	`string`	Регион
`client[].geo.city`	`string`	Город
`agent`	`object`	Информация об агенте
`agent.id`	`number`	Внутренний ID агента в системе
`agent.name`	`string`	Имя агента
`agent.group`	`string`	Группа агента
`agent.geo`	`object`	Местоположение
`agent.geo.ip`	`string`	IP-адрес
`agent.geo.country`	`string`	Страна
`agent.geo.region`	`string`	Регион
`agent.geo.city`	`string`	Город
`agent.os`	`string`	Операционная система. Возможные значения: `win`, `mac`, `linux` или `android`
`agent.version`	`string`	Версия ПО
`agent.owner`	`string`	Логин учетной записи владельца устройства с постоянным доступом
`video`	`object`	Информация о записи видео Может отсутствовать, если подключение не записывалось
`video.url`	`string`	Адрес файла с записью видео Чтобы скачать файл с записью подключения, добавьте параметр `?apikey=` с вашим API-ключом.
`video.size`	`number`	Размер файла записи видео в байтах

Получить информацию о подключении¶

Чтобы получить информацию о конкретном подключении, используйте метод history/info

Запрос:

HTTPcURL

GET /v1/history/info
  ?session_id=<number>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -G "https://api.pro32connect.ru/v1/history/info" \
  --data-urlencode "session_id=<number>" \
  -H "X-Api-Key: YOUR_API_KEY" \

Параметр	Тип	Значение
`session_id`	`number`	Поиск по ID сессии
`session_uid`	`string`	Поиск по UID сессии

Ответ:

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

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

{
  "id": 10573011,
  "uid": "17542170487lJDSVaYcCPB2urQWvod1dipT8VlSWj41414945",
  "agent_id": 1405303,
  "account_id": 7915,
  "agent_account_id": 0,
  "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36",
  "start": 1754217049,
  "stop": 1754217227,
  "video": "https://st.pro32connect.ru/video/1405303/10500000.mp4",
  "video_size": 7530661,
  "turbo_one_time": false,
  "visor_comment": "",
  "url": "/mn3-u1r-e7u",
  "mode": "control",
  "client": {
    "ip": "94.242.23.99",
    "country": "Russia",
    "region": "St.-Petersburg",
    "city": "St Petersburg"
  },
  "agent": {
    "ip": "94.41.230.200",
    "country": "Russia",
    "region": "Bashkortostan Republic",
    "city": "Sterlitamak"
  }
}

Название	Тип	Описание
`id`	`number`	Внутрисистемный идентификатор подключения
`uid`	`string`	Внутрисистемный идентификатор подключения
`agent_id`	`number`	Внутрисистемный идентификатор агента
`account_id`	`number`	Внутрисистемный идентификатор подключившегося техника
`agent_account_id`	`number`	Внутрисистемный идентификатор к какой команде привязан агент
`start`	`unixtime`	Дата и время начала подключения
`stop`	`unixtime`	Дата и время конца подключения Может быть пустым, если подключение не завершено
`video`	`string`	Адрес для загрузки видео-файла записи Чтобы загрузить видео-файл записи подключения необходимо добавить параметр `?apikey=` со значением вашего API-ключа.
`video.size`	`number`	Размер видео-файла записи в байтах
`turbo_one_time`	`boolean`	Подключение к агенту по одноразовой ссылке
`visor_comment`	`string`	Комментарий к сеансу подключения
`url`	`string`	Ссылка агента
`mode`	`string`	Тип подключения. Возможные значения: `control` - подключение к экрану `terminal` - подключение по терминалу `file_manager` - подключение к файловому менеджеру
`client`	`object`	Информация о подключившемся технике
`client.ip`	`string`	IP-адрес
`client.country`	`string`	Страна
`client.region`	`string`	Регион
`client.city`	`string`	Город
`agent`	`object`	Информация об агенте
`agent.ip`	`string`	IP-адрес
`agent.country`	`string`	Страна
`agent.region`	`string`	Регион
`agent.city`	`string`	Город