Используемые соединения
Платформа IVA MCU для своей работы использует следующие относительные пути и типы соединений:
-
клиентское API:
URL (путь) |
Тип соединения |
Методы |
Описание |
/api/rest/* |
HTTP(s) |
GET, POST, PATCH, DELETE |
REST API для выполнения бизнес-логики клиентских приложений. Описание API — /doc/api/rest.html |
/api/rs/* |
HTTP(s) |
GET, POST, DELETE |
API для выполнения утилитарных запросов бизнес-логики клиентских приложений |
/api/ws/* |
HTTP(s) |
POST |
SOAP API для выполнения бизнес-логики клиентских приложений. Устаревшее API — со временем будет полностью замещено REST API |
videoconference/service/* |
HTTP(s) |
POST |
GWT RPC API для выполнения бизнес-логики из старого web-интерфейса. Устаревшее API — со временем будет полностью замещено REST API |
/services/media/* |
HTTP(s) |
POST |
|
/videoframe/service/* |
HTTP(s) |
POST |
|
/videoconference/remote_logging/* |
HTTP(s) |
POST |
|
/videoconference/* |
HTTP(s) |
GET, POST, HEAD |
HTTP API для выполнения утилитарных запросов бизнес-логики из старого web‑интерфейса. Устаревшее API — со временем будет полностью замещено REST API |
/services/resource/* |
HTTP(s) |
GET, POST |
API получения / загрузки файлов с / на сервер от клиентских приложений |
/comet/* |
HTTP(s) |
GET |
Comet-соединение (long polling соединение) используется клиентскими приложениями для получения, обновления данных со стороны сервера бизнес-логики (головные сервера) для возможности поддержания актуального онлайн-состояния на клиентской стороне. В активном состоянии приложение держит открытым это соединение постоянно. Соединение однонаправленное — данные идут только со стороны сервера |
/websocket/eventbus/* |
WSS |
GET |
WSS-соединение используется клиентскими приложениями для получения, обновления данных со стороны сервера бизнес-логики (головные сервера) для возможности поддержания актуального онлайн-состояния на клиентской стороне. В активном состоянии приложение держит открытым это соединение постоянно. Соединение однонаправленное — данные идут только со стороны сервера |
/websocket/media/* |
WSS |
GET |
WSS-соединение устанавливается и используется клиентскими приложениями IVA Connect только на момент нахождения приложений в активном мероприятии или звонке. Оно устанавливается (прокси через головной сервер) с используемым для мероприятия или звонка медиасервером. Соединение двунаправленное и служит для обмена сигнальными командами между клиентским приложением и медиасервером (например отправка / прием SDP, отправка / прием ICE-кандидатов, запрос на изменение подписок в медиаканалах, получение VAD и другое) |
/websocket/screenshare/* |
WSS |
GET |
WSS-соединение устанавливается и используется клиентским приложением IVA Connect Desktop только на момент участия приложения в удаленном управлении рабочим столом в рамках активного мероприятия. Соединение устанавливается с головным сервером, который проксирует команды управления (перемещение мыши, нажатие клавиш на клавиатуре и др.) от одного участника мероприятия к другому. Соединение однонаправленное — направление зависит от роли участника (управляющий, управляемый) в рамках работы функции удаленного управления рабочим столом |
/api/rs/provisioning/firmware/* |
HTTP(s) |
GET |
API для получения конфигураций VoIP-устройствами |
/api/ftp/provisioning/firmware/* |
FTP |
||
/api/tftp/provisioning/firmware/* |
TFTP |
||
/v2/* |
HTTP(s) |
GET |
Статические ресурсы web-интерфейса (тип расширений) |
/downloads/* |
HTTP(s) |
GET |
Дистрибутивы клиентских приложений |
/outlook-plugin/* |
HTTP(s) |
GET |
Статические ресурсы плагина (add-in) для Outlook (тип расширений) |
/doc/api/* |
HTTP(s) |
GET |
Статические ресурсы страниц документации API (тип расширений) |
/* |
HTTP(s) |
GET |
Статические ресурсы старого web-интерфейса (тип расширений) |
| Для Платформы IVA MCU версии 23.0 и старше клиентские приложения для своей работы могут использовать дополнительные каналы событий (/websocket/media/ и /websocket/screenshare/), которые может потребоваться разрешить в настройках WAF или других проксирующих узлах |
-
административное API:
| URL (путь) | Тип соединения | Методы | Описание |
|---|---|---|---|
/administration/service/.* |
HTTP(s) |
POST |
GWT RPC API для выполнения бизнес-логики из web-панели администрирования |
/administration/remote_logging/* |
HTTP(s) |
POST |
|
/videoconference/* |
HTTP(s) |
GET, POST, HEAD |
HTTP API для выполнения утилитарных запросов бизнес-логики из web-панели администрирования |
/* |
HTTP(s) |
GET |
Статические ресурсы web-панели администрирования (тип расширений) |
-
интеграционное API:
| URL (путь) | Тип соединения | Методы | Описание |
|---|---|---|---|
/api/rest/integration/* |
HTTP(s) |
GET, POST, PATCH, DELETE |
REST API для интеграционных решений. Описание API — /doc/api/integration.html |
-
чат-бот API:
| URL (путь) | Тип соединения | Методы | Описание |
|---|---|---|---|
/api/rest/bot/* |
HTTP(s) |
GET, POST, PATCH, DELETE |
REST API для чат-ботов. Описание API — /doc/api/bot.html |
Расширения для статических ресурсов:
Требования к межсетевым экранам для web‑приложений
Перечень требований к межсетевым экранам для web-приложений:
-
межсетевой экран для web-приложений (WAF, PTAF и др.) должен поддерживать Chunked transfer encoding (например для nginx должна быть выключена опция proxy_buffering)
-
для корректной работы Платформы IVA MCU на межсетевом экране для web-приложений необходимо настроить исключения для URL
Если по соображениям безопасности нельзя настроить такие исключения для URL, то, если позволяют возможности межсетевого экрана для web-приложений, можно поставить межсетевой экран на обучение. Однако в таком случае есть вероятность того, что после каждого обновления придется переобучать этот межсетевой экран -
если необходимо, чтобы в Платформе IVA MCU фиксировались фактические IP-адреса пользователей, то необходимо, чтобы межсетевой экран для web-приложений указывал фактические адреса пользователей в HTTP-заголовке X-Real-IP
Настройка внешних HTTP-прокси
Для того чтобы Платформа IVA MCU могла фиксировать фактические IP-адреса пользователей, подключающихся к Платформе, необходимо:
Войти в web-панель администрирования → Перейти в раздел Системные настройки 
→ Перейти к секции Системные настройки → Поле Внешние HTTP прокси 
→ Ввести IP-адрес межсетевого экрана для web-приложений (IP-адрес пользователя берется из HTTP‑заголовка X-Real-IP; если IP-адресов несколько, то в качестве разделительного символа необходимо использовать точку с запятой)
