bbbserver.de IntegratieAPI
De IntegrationAPI op bbbserver.de is een proxy die de standaard BigBlueButton-API weerspiegelt en conferenties op de achtergrond over meerdere servers met voldoende capaciteit verdeelt.
bbbserver.de is een in de EU gevestigd premium hostingplatform voor BigBlueButton met servers in de EU. Externe applicaties verbinden via de vertrouwde BBB-API en gedragen zich alsof ze met één enkele server communiceren.
Waar vind je de API-URL en het gedeelde geheim
Je API-URL en shared secret zijn beschikbaar in het beheerpaneel van bbbserver onder Integraties & API's → Integratie-API. De IntegrationAPI kan daar ook worden in- of uitgeschakeld.
Je hebt geen shelltoegang of bbb-conf-opdrachten nodig om toegangsgegevens op te halen wanneer je bbbserver.de gebruikt.
Plugin Compatibiliteit
De volgende platforms werken direct. In de meeste gevallen hoef je alleen de API-URL en shared secret in te voeren in de standaard BigBlueButton-integratie.
- Moodle (BigBlueButtonBN)
- ILIAS
- Nextcloud
- WordPress
- Greenlight
Verschillen met de standaard-API
De IntegrationAPI weerspiegelt de standaard BBB-API nauwkeurig, maar verschillende gedragingen op bbbserver.de wijken voldoende af om ze tijdens de integratie expliciet te begrijpen.
Capaciteitsreservering
Wanneer je een conferentie aanmaakt via de IntegrationAPI, moet bbbserver.de deze toewijzen aan een backendserver met voldoende resterende resources. Daarom fungeren maxParticipants en duration als een reserveringsverzoek voor verbindings- en runtimecapaciteit in plaats van alleen het documenteren van verwacht gebruik.
Beide waarden moeten daarom worden opgegeven bij create-aanroepen. Als ze worden weggelaten, worden de standaardwaarden uit Integraties & API's → Integratie-API gebruikt.
Voorbeeld van capaciteitsreservering
Het volgende voorbeeld laat zien hoe op reservering gebaseerde capaciteitsplanning het gedrag verandert ten opzichte van de normale aanname van één server:
| Situatie | Effect op capaciteit |
|---|---|
| Je account staat 20 gelijktijdige verbindingen toe | Dit is de totale verbindingspool die beschikbaar is voor actieve reserveringen. |
Conferentie A wordt aangemaakt met maxParticipants = 15 en duration = 120 minutes | Conferentie A reserveert 15 van de 20 beschikbare verbindingen voor het volledige reserveringsvenster van twee uur. |
| Tijdens die twee uur wordt nog een conferentie aangemaakt | Deze kan niet meer dan de resterende 5 verbindingen reserveren zolang conferentie A nog binnen zijn gereserveerde tijdvenster valt. |
| De twee uur zijn voorbij en conferentie A loopt nog steeds | Conferentie A mag doorgaan, maar de gereserveerde capaciteit is niet langer gegarandeerd of beschermd. |
Conferentie B wordt later aangemaakt met maxParticipants = 10 | Het systeem kan conferentie A automatisch beëindigen ten gunste van conferentie B, omdat conferentie A niet langer door een actieve reservering wordt beschermd. |
Gedrag van parameter "duration"
Op bbbserver.de maakt duration deel uit van de capaciteitsplanning en beëindigt het een vergadering niet automatisch wanneer de ingestelde tijd wordt overschreden.
Omdat duration op bbbserver.de deze reserveringsbetekenis heeft, beëindigt het overschrijden van de ingestelde duur een vergadering nooit automatisch. Als je workflow een vaste eindtijd vereist, plan dan een expliciete end-API-aanroep.
Extra parameter voor white-labeling
deactivateBbbserverDefaultChatTexts accepteert true of false en heeft standaard false.
Zolang deze op false blijft staan, voegt bbbserver.de zijn eigen chattekst toe met inbelinstructies en een hostingmelding. Je teksten welcome en moderatorOnlyMessage worden daarna toegevoegd. Stel de parameter in op true als je die standaardteksten van bbbserver wilt uitschakelen voor white-labeling.
Niet-beschikbare endpoints
De volgende API-aanroepen bestaan in de standaard-API, maar worden niet geïmplementeerd door de IntegratieAPI:
updateRecordings, getDefaultConfigXML, setConfigXML, getRecordingTextTracks, putRecordingTextTrack
Webhooks
Hooks moeten voor specifieke vergaderings-ID's worden geregistreerd. Registratie voor alle vergaderingen zonder een vergaderings-ID op te geven wordt niet ondersteund.
Webhookgebeurtenissen kunnen gevoelige informatie bevatten. bbbserver.de verwijdert of anonimiseert daarom privacygevoelige velden automatisch, waardoor gegevens zoals IP-adressen van deelnemers mogelijk niet beschikbaar zijn.
Snelheidslimieten
Er zijn geen snelheidslimieten op de IntegrationAPI.
Naast de IntegrationAPI biedt bbbserver.de een afzonderlijke System API met platformspecifieke functies zoals accountbeheer en gebruiksstatistieken. De System API is niet compatibel met BBB en wordt niet behandeld in deze handleiding.
Veelgestelde vragen
maxParticipants en duration reserveren capaciteit, vergaderingen worden niet automatisch beëindigd, deactivateBbbserverDefaultChatTexts regelt chatteksten van het platform, sommige endpoints zijn niet beschikbaar en webhooks zijn vergaderingsspecifiek.