Skip to content

REST API VideoGrace Server

REST API используется для интеграции VideoGrace Server с внешними системами: порталами, CRM, helpdesk, внутренними личными кабинетами и средствами автоматизации. Через API можно создавать и обновлять пользователей, управлять группами, получать сведения о конференциях и встраивать VideoGrace в существующие бизнес-процессы.

API не заменяет панель администратора, а дополняет ее там, где нужны массовые операции или синхронизация с внешним источником данных.

Базовый адрес

Запросы выполняются к серверу VideoGrace по тому же домену и TCP-порту, которые используются клиентами:

https://<адрес_сервера>/

Для публичного сервера рекомендуется использовать домен и доверенный TLS-сертификат. См. инструкцию развертывания на VPS со своим доменом и Let's Encrypt.

Типовые сценарии

REST API обычно применяют для следующих задач:

  • автоматическое создание учетных записей сотрудников;
  • синхронизация пользователей и групп с кадровой или корпоративной системой;
  • подготовка постоянных конференций для подразделений;
  • выдача ссылок на подключение к конференциям из внешнего портала;
  • отключение или блокировка учетных записей при увольнении сотрудника;
  • аудит состава пользователей и групп.

Безопасность

API должен быть доступен только доверенным системам. Для production-инсталляции рекомендуется:

  • использовать только HTTPS;
  • ограничить доступ к API на уровне firewall или reverse proxy, если API нужен только внутренним сервисам;
  • завести отдельную служебную учетную запись для интеграции;
  • не использовать учетную запись admin в автоматических скриптах;
  • хранить пароли и токены интеграций вне исходного кода.

Данные и идентификаторы

При интеграции важно различать:

Сущность Назначение
Пользователь Учетная запись человека или сервисного клиента
Группа Организационная структура и видимость контактов
Конференция Постоянная или временная комната для аудио/видео/чата
Тег конференции Человекочитаемый идентификатор конференции и часть URL

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

Рекомендации по интеграции

  1. Начинайте с тестового сервера и отдельной тестовой группы.
  2. Логируйте все операции внешней системы: создание, обновление, блокировку.
  3. Делайте операции идемпотентными: повторный запуск синхронизации не должен создавать дубликаты.
  4. Не удаляйте пользователей физически, если нужна история конференций и сообщений; предпочтительнее блокировка или деактивация.
  5. После массовых изменений проверяйте результат в панели администратора и в клиентском приложении.

Связанные разделы