# API

TrueConf MCU поддерживает OAS3 — спецификацию OpenAPI версии 3 (opens new window) (ранее Swagger Specification).

/docs/mcu/media/api/ru.png

# Возможности

Через API вы можете:

  • управлять:

    • адресной книгой (создавать, редактировать пользователей и группы);

    • конференцией (раскладками, аудиоканалами, участниками и тд.);

  • получать статистику использования ресурсов;

  • обновлять сервер;

  • перезагружать ОС, выключать или перезапускать сервер;

  • выполнять настройку времени и NTP;

  • выполнять резервное копирование, экспорт и импорт данных (также с TrueConf MCU версии 1.5);

  • производить диагностику сети;

  • регистрировать лицензию;

  • планировать конференцию;

  • и многое другое.

# Доступ к API

Документация REST API доступна на машине с установленным TrueConf MCU. Чтобы получить к ней доступ вам необходимо перейти по адресу {IP_or_FQDN}/api/doc/, где {IP_or_FQDN} — IP или доменное имя (FQDN) машины с MCU, например, 10.110.2.244/api/doc/.

# Помощь с API

Если у вас возникли вопросы касаемо продукта или API, то вы их можете задать в нашем Telegram сообществе (opens new window).

Обновлено: 13.09.2024