Версія API: 4.x найновіша 3.x

Ви переглядаєте документацію API для BigBlueButton 3.x. Поточна версія — BigBlueButton 4.x. Плануєте оновлення? У посібнику з міграції наведено всі зміни, які потрібно внести у ваші виклики API.

Розділ 24

bbbserver.de IntegrationAPI

IntegrationAPI на bbbserver.de — це проксі, який віддзеркалює стандартний API BigBlueButton, одночасно розподіляючи конференції між кількома серверами з достатньою доступною ємністю у фоновому режимі.

Де знайти URL API і спільний секрет

URL-адреса вашого API та shared secret доступні в панелі адміністратора bbbserver у розділі Інтеграції та API → 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. Якщо їх не вказано, використовуються стандартні значення з розділу Інтеграції та API → 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 використовується для планування ресурсів. Зустріч не завершується точно в момент перевищення налаштованого часу. Натомість bbbserver.de автоматично завершує зустріч у таких випадках:

  • Через 10 хвилин після запланованого часу завершення, якщо жоден учасник більше не підключений.
  • Для пробних підписок: у запланований час завершення.
  • Не пізніше ніж через 24 години після початку.
  • Коли ресурси потрібні для іншої зустрічі, а поточна зустріч більше не захищена своїм резервуванням (див. приклад вище).

Якщо ваш робочий процес вимагає фіксованого часу завершення, заплануйте явний виклик API end.

Додатковий параметр для white-labeling

deactivateBbbserverDefaultChatTexts приймає значення true або false, а значенням за замовчуванням є false.

Поки значення залишається false, bbbserver.de додає власний текст перед вашим текстом welcome: посилання на bbbserver.de, інструкції з телефонного підключення та повідомлення про хостинг. Модератори додатково бачать текст із максимальною кількістю учасників, запланованим часовим проміжком і приміткою про те, що зустріч може бути завершена, коли знадобляться ресурси. Установіть для параметра значення true, якщо хочете вимкнути ці стандартні тексти для використання під власним брендом.

Стандартні тексти також можна приховати в налаштуваннях клієнта. У такому разі текст для модератора завжди пропускається, а вітальний текст пропускається, якщо ви передаєте власний текст welcome.

Недоступні ендпоїнти

Наведені нижче виклики API існують у стандартному API, але не реалізовані в IntegrationAPI:

getJoinUrl, sendChatMessage, updateRecordings, getRecordingTextTracks, putRecordingTextTrack, hooks/ping

Неопубліковані записи

Якщо ви скасуєте публікацію запису, він відображатиметься в API як unpublished, і зовнішні сервіси оброблятимуть його відповідно. Однак сам запис усе ще можна відкрити, якщо відоме посилання для відтворення.

Вебхуки

Hooks мають реєструватися для конкретних ідентифікаторів зустрічей. Реєстрація для всіх зустрічей без указання ідентифікатора зустрічі не підтримується.

Події вебхуків фільтруються перед пересиланням: передаються лише вибрані поля. Дані учасників, як-от ім’я, external-user-id, агент користувача та параметри userdata, передаються у відкритому вигляді. Усі інші поля, зокрема IP-адреси учасників, повідомлення чату та дані опитувань, видаляються.

Обмеження швидкості

Для IntegrationAPI немає обмежень швидкості.

Окрім IntegrationAPI, bbbserver.de пропонує окремий System API із функціями, специфічними для платформи, такими як керування обліковими записами та статистика використання. System API не є сумісним із BBB і не розглядається в цьому посібнику.

Поширені запитання

Відкрийте панель адміністратора bbbserver і перейдіть до розділу Інтеграції та API → API інтеграції. Там ви можете переглянути URL-адресу API, скопіювати shared secret, а також увімкнути або вимкнути IntegrationAPI.

IntegrationAPI розроблено для роботи зі стандартними інтеграціями BigBlueButton, такими як Moodle, ILIAS, Nextcloud, WordPress і Greenlight.

bbbserver.de IntegrationAPI відтворює стандартний API BBB, але maxParticipants і duration резервують ресурси, зустрічі не завершуються точно після спливу налаштованої тривалості, deactivateBbbserverDefaultChatTexts керує текстами платформи в чаті, деякі кінцеві точки недоступні, а вебхуки прив’язані до конкретних зустрічей.

Адміністратори можуть тимчасово ввімкнути журнал запитів (режим розробника) на сторінці Integrations & API → Integration API. Він залишається активним протягом одного дня та зберігає до 300 записів, кожен упродовж 24 годин. Не журналюються запити без дійсної автентифікації, запити з відповіддю 404 і відповіді getMeetingInfo, insertDocument та hooks/list, що передаються без змін. Журнал запитів дає змогу тестувати сам API, перевіряти власну інтеграцію та досліджувати поведінку API на практиці.
Посібник з API BigBlueButton