bbbserver.de IntegrationAPI
IntegrationAPI på bbbserver.de er en proxy, der spejler standard-BigBlueButton-API'en, mens den i baggrunden fordeler konferencer på flere servere med tilstrækkelig kapacitet.
bbbserver.de er en EU-baseret premium-hostingplatform til BigBlueButton med servere placeret i EU. Eksterne applikationer forbinder via den velkendte BBB-API og opfører sig, som om de talte med en enkelt server.
Hvor finder man API-URL og delt hemmelighed
Din API-URL og shared secret er tilgængelige i administrationspanelet for bbbserver under Integrationer & API'er → Integration-API. IntegrationAPI kan også aktiveres eller deaktiveres der.
Du behøver ikke shell-adgang eller bbb-conf-kommandoer for at hente legitimationsoplysninger, når du bruger bbbserver.de.
Plugin-kompatibilitet
Følgende platforme virker med det samme. I de fleste tilfælde skal du kun indtaste API-URL'en og shared secret i standard-BigBlueButton-integrationen.
- Moodle (BigBlueButtonBN)
- ILIAS
- Nextcloud
- WordPress
- Greenlight
Forskelle i forhold til standard-API'et
IntegrationAPI spejler standard-BBB-API'en tæt, men flere funktioner på bbbserver.de er tilstrækkeligt forskellige til, at de bør forstås eksplicit under integrationen.
Kapacitetsreservation
Når du opretter en konference via IntegrationAPI, skal bbbserver.de tildele den til en backend-server med nok resterende ressourcer. Derfor fungerer maxParticipants og duration som en reservationsanmodning for forbindelses- og driftkapacitet i stedet for blot at dokumentere forventet brug.
Begge værdier bør derfor angives ved create-kald. Hvis de udelades, bruges standardværdierne fra Integrationer & API'er → Integration-API.
Eksempel på kapacitetsreservation
Følgende eksempel viser, hvordan reservationsbaseret kapacitetsplanlægning ændrer adfærden sammenlignet med en normal antagelse om én server:
| Situation | Effekt på kapacitet |
|---|---|
| Din konto tillader 20 samtidige forbindelser | Dette er den samlede forbindelsespulje, der er tilgængelig for aktive reservationer. |
Konference A oprettes med maxParticipants = 15 og duration = 120 minutes | Konference A reserverer 15 af de 20 tilgængelige forbindelser for hele reservationsvinduet på to timer. |
| En anden konference oprettes i løbet af de to timer | Den kan ikke reservere mere end de 5 resterende forbindelser, så længe konference A stadig er inden for sit reserverede tidsvindue. |
| De to timer er gået, og konference A kører stadig | Konference A kan fortsætte, men dens reserverede kapacitet er ikke længere garanteret eller beskyttet. |
Konference B oprettes senere med maxParticipants = 10 | Systemet kan automatisk afslutte konference A til fordel for konference B, fordi konference A ikke længere er beskyttet af en aktiv reservation. |
Funktionsmåde for parameteren "duration"
På bbbserver.de er duration en del af kapacitetsplanlægningen og afslutter ikke automatisk et møde, når den konfigurerede tid overskrides.
Fordi duration har denne reservationsbetydning på bbbserver.de, afslutter overskridelse af den konfigurerede varighed aldrig automatisk et møde. Hvis dit workflow kræver et fast sluttidspunkt, skal du planlægge et eksplicit end-API-kald.
Yderligere parameter til white-labeling
deactivateBbbserverDefaultChatTexts accepterer true eller false og har som standard false.
Så længe den forbliver false, tilføjer bbbserver.de sin egen chattekst med indringningsinstruktioner og en hostingmeddelelse. Dine welcome- og moderatorOnlyMessage-tekster tilføjes bagefter. Sæt parameteren til true, hvis du vil deaktivere disse standardtekster fra bbbserver til white-labeling.
Utilgængelige endpoints
Følgende API-kald findes i standard-API'en, men er ikke implementeret af IntegrationAPI:
updateRecordings, getDefaultConfigXML, setConfigXML, getRecordingTextTracks, putRecordingTextTrack
Webhooks
Hooks skal registreres for specifikke møde-id'er. Registrering for alle møder uden angivelse af et møde-id understøttes ikke.
Webhook-hændelser kan indeholde følsomme oplysninger. bbbserver.de fjerner eller slører derfor automatisk felter, der er følsomme for privatlivets fred, så data som deltageres IP-adresser muligvis ikke er tilgængelige.
Rate limits
Der er ingen rate limits på IntegrationAPI.
Ud over IntegrationAPI tilbyder bbbserver.de et separat System API med platformspecifikke funktioner såsom kontoadministration og brugsstatistik. System API er ikke BBB-kompatibelt og er ikke dækket af denne vejledning.
Ofte stillede spørgsmål
maxParticipants og duration reserverer kapacitet, møder afsluttes ikke automatisk, deactivateBbbserverDefaultChatTexts styrer platformens chattekster, nogle endpoints er utilgængelige, og webhooks er mødespecifikke.