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.
Вам не потрібен shell-доступ або команди bbb-conf, щоб отримати облікові дані під час використання 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.
Недоступні ендпоїнти
Наведені нижче виклики 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 керує текстами чату платформи, деякі ендпоїнти недоступні, а webhook-и прив’язані до конкретних зустрічей.