bbbserver.de IntegrationAPI
IntegrationAPI на bbbserver.de — это прокси, который отражает стандартный API BigBlueButton, одновременно распределяя конференции между несколькими серверами с достаточной доступной ёмкостью в фоновом режиме.
bbbserver.de — это премиальная хостинг-платформа для BigBlueButton с серверами, расположенными в ЕС. Внешние приложения подключаются через привычный API BBB и работают так, как будто взаимодействуют с одним сервером.
Где найти URL API и общий секрет
Ваш URL API и shared secret доступны в панели администратора bbbserver в разделе Integrations & APIs → Integration-API. Там же можно включить или отключить IntegrationAPI.
При использовании bbb-conf вам не нужен доступ к shell или команды bbbserver.de, чтобы получить учётные данные.
Совместимость Plugin
Следующие платформы работают из коробки. В большинстве случаев вам нужно только ввести URL API и shared secret в стандартную интеграцию BigBlueButton.
- Moodle (BigBlueButtonBN)
- ILIAS
- Nextcloud
- WordPress
- Greenlight
Отличия от стандартного API
IntegrationAPI тесно повторяет стандартный API BBB, однако некоторые особенности поведения на bbbserver.de достаточно отличаются, и их следует явно учитывать при интеграции.
Резервирование ёмкости
Когда вы создаёте конференцию через IntegrationAPI, bbbserver.de должен назначить её внутреннему серверу с достаточными оставшимися ресурсами. Поэтому maxParticipants и duration выступают как запрос на резервирование ёмкости подключения и времени выполнения, а не просто как указание ожидаемого использования.
Поэтому оба значения следует указывать в вызовах create. Если они не указаны, используются значения по умолчанию из Integrations & APIs → Integration-API.
Пример резервирования ёмкости
Следующий пример показывает, как планирование ёмкости на основе резервирования меняет поведение по сравнению с обычным предположением об одном сервере:
| Ситуация | Влияние на ёмкость |
|---|---|
| Ваша учётная запись допускает 20 одновременных подключений | Это общий пул подключений, доступный для активных резервирований. |
Конференция A создаётся с maxParticipants = 15 и duration = 120 minutes | Конференция A резервирует 15 из 20 доступных подключений на всё двухчасовое окно резервирования. |
| В течение этих двух часов создаётся другая конференция | Она не может зарезервировать больше чем оставшиеся 5 подключений, пока конференция A всё ещё находится в пределах своего зарезервированного временного окна. |
| Два часа прошли, а конференция A всё ещё идёт | Конференция A может продолжаться, но её зарезервированная ёмкость больше не гарантируется и не защищается. |
Позже создаётся конференция B с maxParticipants = 10 | Система может автоматически завершить конференцию A в пользу конференции B, потому что конференция A больше не защищена активным резервированием. |
Поведение параметра "duration"
На bbbserver.de параметр duration является частью планирования ёмкости и не завершает встречу автоматически при превышении настроенного времени.
Поскольку duration на bbbserver.de имеет значение резервирования, превышение заданной длительности никогда не завершает встречу автоматически. Если вашему процессу требуется фиксированное время окончания, запланируйте явный вызов API end.
Дополнительный параметр для white-labeling
deactivateBbbserverDefaultChatTexts принимает значения true или false, а по умолчанию используется false.
Пока значение остаётся false, bbbserver.de добавляет собственный текст чата с инструкциями по подключению по телефону и уведомлением о хостинге. После этого добавляются ваши тексты welcome и moderatorOnlyMessage. Установите параметр в true, если хотите отключить эти стандартные тексты bbbserver для white-labeling.
Недоступные endpoints
Следующие вызовы API существуют в стандартном API, но не реализованы в IntegrationAPI:
updateRecordings, getDefaultConfigXML, setConfigXML, getRecordingTextTracks, putRecordingTextTrack
Вебхуки
Hooks должны регистрироваться для конкретных идентификаторов встреч. Регистрация для всех встреч без указания идентификатора встречи не поддерживается.
События webhook могут содержать конфиденциальную информацию. Поэтому bbbserver.de автоматически удаляет или маскирует поля, чувствительные с точки зрения конфиденциальности, из-за чего такие данные, как IP-адреса участников, могут быть недоступны.
Ограничения скорости
Для IntegrationAPI ограничения скорости отсутствуют.
Помимо IntegrationAPI, bbbserver.de предлагает отдельный System API со специфическими для платформы функциями, такими как управление аккаунтами и статистика использования. System API не совместим с BBB и не рассматривается в этом руководстве.
Часто задаваемые вопросы
maxParticipants и duration резервируют ёмкость, встречи не завершаются автоматически, deactivateBbbserverDefaultChatTexts управляет текстами чата платформы, некоторые endpoints недоступны, а webhooks привязаны к конкретным встречам.