bbbserver.de IntegrationAPI
IntegrationAPI na bbbserver.de to proxy, które odzwierciedla standardowe API BigBlueButton, jednocześnie rozdzielając konferencje w tle pomiędzy wiele serwerów z wystarczającą dostępną pojemnością.
bbbserver.de to oparta w UE platforma premium hostingu dla BigBlueButton z serwerami zlokalizowanymi w UE. Zewnętrzne aplikacje łączą się za pośrednictwem znanego API BBB i działają tak, jakby komunikowały się z jednym serwerem.
Gdzie znaleźć URL API i wspólny sekret
Twój URL API i shared secret są dostępne w panelu administracyjnym bbbserver w sekcji Integracje i API → Integration-API. Tam można również włączyć lub wyłączyć IntegrationAPI.
Nie potrzebujesz dostępu do shella ani poleceń bbb-conf, aby pobrać dane uwierzytelniające podczas korzystania z bbbserver.de.
Kompatybilność Plugin
Poniższe platformy działają od razu. W większości przypadków wystarczy wpisać URL API i shared secret w standardowej integracji BigBlueButton.
- Moodle (BigBlueButtonBN)
- ILIAS
- Nextcloud
- WordPress
- Greenlight
Różnice względem standardowego API
IntegrationAPI ściśle odzwierciedla standardowe API BBB, ale kilka zachowań w bbbserver.de różni się na tyle, że należy je wyraźnie zrozumieć podczas integracji.
Rezerwacja pojemności
Gdy tworzysz konferencję przez IntegrationAPI, bbbserver.de musi przypisać ją do serwera backendowego z wystarczającą ilością pozostałych zasobów. Dlatego maxParticipants i duration działają jako żądanie rezerwacji pojemności połączeń i czasu działania, a nie jedynie jako opis oczekiwanego użycia.
Obie wartości powinny być zatem podawane w wywołaniach create. Jeśli zostaną pominięte, użyte zostaną wartości domyślne z Integracje i API → Integration-API.
Przykład rezerwacji pojemności
Poniższy przykład pokazuje, jak planowanie pojemności oparte na rezerwacji zmienia zachowanie w porównaniu ze zwykłym założeniem pojedynczego serwera:
| Sytuacja | Wpływ na pojemność |
|---|---|
| Twoje konto pozwala na 20 jednoczesnych połączeń | To jest łączna pula połączeń dostępna dla aktywnych rezerwacji. |
Konferencja A została utworzona z maxParticipants = 15 i duration = 120 minutes | Konferencja A rezerwuje 15 z 20 dostępnych połączeń na całe dwugodzinne okno rezerwacji. |
| W ciągu tych dwóch godzin tworzona jest kolejna konferencja | Nie może ona zarezerwować więcej niż pozostałe 5 połączeń, dopóki konferencja A nadal znajduje się w swoim zarezerwowanym oknie czasowym. |
| Minęły dwie godziny, a konferencja A nadal trwa | Konferencja A może być kontynuowana, ale jej zarezerwowana pojemność nie jest już gwarantowana ani chroniona. |
Konferencja B zostaje później utworzona z maxParticipants = 10 | System może automatycznie zakończyć konferencję A na rzecz konferencji B, ponieważ konferencja A nie jest już chroniona aktywną rezerwacją. |
Zachowanie parametru „duration”
W bbbserver.de duration jest częścią planowania pojemności i nie kończy automatycznie spotkania po przekroczeniu skonfigurowanego czasu.
Ponieważ duration ma w bbbserver.de znaczenie rezerwacyjne, przekroczenie skonfigurowanego czasu trwania nigdy nie kończy spotkania automatycznie. Jeśli Twój workflow wymaga stałej godziny zakończenia, zaplanuj jawne wywołanie API end.
Dodatkowy parametr dla white-labelingu
deactivateBbbserverDefaultChatTexts akceptuje prawda lub fałsz, a domyślną wartością jest fałsz.
Dopóki pozostaje fałsz, bbbserver.de dodaje własny tekst czatu z instrukcjami dotyczącymi połączenia telefonicznego i informacją o hostingu. Twoje teksty welcome i moderatorOnlyMessage są dodawane później. Ustaw parametr na prawda, jeśli chcesz wyłączyć te domyślne teksty bbbserver na potrzeby white-labelingu.
Niedostępne endpointy
Poniższe wywołania API istnieją w standardowym API, ale nie są zaimplementowane w IntegrationAPI:
updateRecordings, getDefaultConfigXML, setConfigXML, getRecordingTextTracks, putRecordingTextTrack
Webhooki
Hooki muszą być rejestrowane dla konkretnych identyfikatorów spotkań. Rejestracja dla wszystkich spotkań bez podania identyfikatora spotkania nie jest obsługiwana.
Zdarzenia webhook mogą zawierać informacje wrażliwe. Dlatego bbbserver.de automatycznie usuwa lub zaciemnia pola wrażliwe z punktu widzenia prywatności, więc dane takie jak adresy IP uczestników mogą być niedostępne.
Limity szybkości
Na IntegrationAPI nie obowiązują żadne limity szybkości.
Oprócz IntegrationAPI, bbbserver.de oferuje osobne System API z funkcjami specyficznymi dla platformy, takimi jak zarządzanie kontem i statystyki użycia. System API nie jest kompatybilne z BBB i nie jest omówione w tym przewodniku.
Najczęściej zadawane pytania
maxParticipants i duration rezerwują pojemność, spotkania nie są kończone automatycznie, deactivateBbbserverDefaultChatTexts kontroluje teksty czatu platformy, niektóre endpointy są niedostępne, a webhooki są specyficzne dla spotkań.