bbbserver.de IntegrationAPI
Die IntegrationAPI auf bbbserver.de ist ein Proxy, der die standardmäßige BigBlueButton-API spiegelt und dabei Konferenzen im Hintergrund auf mehrere Server mit ausreichender Kapazität verteilt.
bbbserver.de ist eine EU-basierte Premium-Hosting-Plattform für BigBlueButton mit Servern in der EU. Externe Anwendungen verbinden sich über die bekannte BBB-API und verhalten sich so, als würden sie mit einem einzigen Server sprechen.
Wo Sie API-URL und Shared Secret finden
Ihre API-URL und das shared secret sind im bbbserver-Admin-Panel unter Integrationen & APIs → Integration-API verfügbar. Das IntegrationAPI kann dort auch aktiviert oder deaktiviert werden.
Sie benötigen keinen Shell-Zugriff oder bbb-conf-Befehle, um Anmeldedaten abzurufen, wenn Sie bbbserver.de verwenden.
Plugin Kompatibilität
Die folgenden Plattformen funktionieren sofort. In den meisten Fällen müssen Sie nur die API-URL und das shared secret in die standardmäßige BigBlueButton-Integration eintragen.
- Moodle (BigBlueButtonBN)
- ILIAS
- Nextcloud
- WordPress
- Greenlight
Unterschiede zur Standard-API
Die IntegrationAPI spiegelt die standardmäßige BBB-API weitgehend, aber einige Verhaltensweisen auf bbbserver.de unterscheiden sich deutlich genug, dass sie bei der Integration ausdrücklich verstanden werden sollten.
Kapazitätsreservierung
Wenn Sie eine Konferenz über die IntegrationAPI erstellen, muss bbbserver.de sie einem Backend-Server mit genügend verbleibenden Ressourcen zuweisen. Deshalb fungieren maxParticipants und duration als Reservierungsanfrage für Verbindungs- und Laufzeitkapazität, anstatt lediglich die erwartete Nutzung zu dokumentieren.
Beide Werte sollten daher bei create-Aufrufen angegeben werden. Wenn sie weggelassen werden, werden die Standardwerte aus Integrationen & APIs → Integration-API verwendet.
Beispiel für Kapazitätsreservierung
Das folgende Beispiel zeigt, wie eine reservierungsbasierte Kapazitätsplanung das Verhalten im Vergleich zur normalen Annahme eines einzelnen Servers verändert:
| Situation | Auswirkung auf die Kapazität |
|---|---|
| Ihr Konto erlaubt 20 gleichzeitige Verbindungen | Dies ist der gesamte Verbindungspool, der für aktive Reservierungen verfügbar ist. |
Konferenz A wird mit maxParticipants = 15 und duration = 120 minutes erstellt | Konferenz A reserviert 15 der 20 verfügbaren Verbindungen für das gesamte zweistündige Reservierungsfenster. |
| Während dieser zwei Stunden wird eine weitere Konferenz erstellt | Sie kann nicht mehr als die verbleibenden 5 Verbindungen reservieren, solange sich Konferenz A noch innerhalb ihres reservierten Zeitfensters befindet. |
| Die zwei Stunden sind vorbei und Konferenz A läuft noch | Konferenz A kann weiterlaufen, aber ihre reservierte Kapazität ist nicht mehr garantiert oder geschützt. |
Konferenz B wird später mit maxParticipants = 10 erstellt | Das System kann Konferenz A automatisch zugunsten von Konferenz B beenden, weil Konferenz A nicht mehr durch eine aktive Reservierung geschützt ist. |
Verhalten des Parameters "duration"
Auf bbbserver.de ist duration Teil der Kapazitätsplanung und beendet ein Meeting nicht automatisch, wenn die konfigurierte Zeit überschritten wird.
Da duration auf bbbserver.de diese Reservierungsbedeutung hat, beendet das Überschreiten der konfigurierten Dauer ein Meeting niemals automatisch. Wenn Ihr Arbeitsablauf eine feste Endzeit erfordert, planen Sie einen ausdrücklichen end-API-Aufruf ein.
Zusätzlicher Parameter für White-Labeling
deactivateBbbserverDefaultChatTexts akzeptiert true oder false und verwendet standardmäßig false.
Solange der Wert false bleibt, fügt bbbserver.de eigenen Chat-Text mit Einwahlanweisungen und einem Hosting-Hinweis hinzu. Ihre Texte welcome und moderatorOnlyMessage werden anschließend angehängt. Setzen Sie den Parameter auf true, wenn Sie diese standardmäßigen bbbserver-Texte für White-Labeling deaktivieren möchten.
Nicht verfügbare Endpunkte
Die folgenden API-Aufrufe existieren in der Standard-API, werden aber von der IntegrationAPI nicht implementiert:
updateRecordings, getDefaultConfigXML, setConfigXML, getRecordingTextTracks, putRecordingTextTrack
Webhooks
Hooks müssen für bestimmte Meeting-IDs registriert werden. Eine Registrierung für alle Meetings ohne Angabe einer Meeting-ID wird nicht unterstützt.
Webhook-Ereignisse können sensible Informationen enthalten. bbbserver.de entfernt oder verschleiert daher datenschutzrelevante Felder automatisch, sodass Daten wie Teilnehmer-IP-Adressen möglicherweise nicht verfügbar sind.
Ratenbegrenzungen
Für die IntegrationAPI gibt es keine Ratenbegrenzungen.
Zusätzlich zur IntegrationAPI bietet bbbserver.de eine separate System API mit plattformspezifischen Funktionen wie Kontoverwaltung und Nutzungsstatistiken. Die System API ist nicht BBB-kompatibel und wird in diesem Leitfaden nicht behandelt.
Häufig gestellte Fragen
maxParticipants und duration reservieren Kapazität, Meetings werden nicht automatisch beendet, deactivateBbbserverDefaultChatTexts steuert Chat-Texte der Plattform, einige Endpunkte sind nicht verfügbar und Webhooks sind meetingspezifisch.