bbbserver.de IntegrationAPI
Il IntegrationAPI su bbbserver.de è un proxy che rispecchia l'API standard di BigBlueButton distribuendo al contempo le conferenze su più server con capacità sufficiente in background.
bbbserver.de è una piattaforma di hosting premium con sede nell'UE per BigBlueButton con server situati nell'UE. Le applicazioni esterne si connettono tramite la familiare API BBB e si comportano come se stessero comunicando con un singolo server.
Dove trovare l'URL API e il segreto condiviso
Il tuo URL API e il tuo shared secret sono disponibili nel pannello di amministrazione di bbbserver sotto Integrazioni e API → Integration-API. Anche il IntegrationAPI può essere abilitato o disabilitato lì.
Non hai bisogno dell'accesso shell o dei comandi bbb-conf per recuperare le credenziali quando utilizzi bbbserver.de.
Compatibilità Plugin
Le seguenti piattaforme funzionano subito. Nella maggior parte dei casi, devi solo inserire l'URL API e il shared secret nell'integrazione standard di BigBlueButton.
- Moodle (BigBlueButtonBN)
- ILIAS
- Nextcloud
- WordPress
- Greenlight
Differenze rispetto all'API standard
Il IntegrationAPI rispecchia fedelmente l'API standard di BBB, ma diversi comportamenti su bbbserver.de sono abbastanza diversi da dover essere compresi esplicitamente durante l'integrazione.
Riserva di capacità
Quando crei una conferenza tramite il IntegrationAPI, bbbserver.de deve assegnarla a un server backend con risorse residue sufficienti. Per questo motivo, maxParticipants e duration agiscono come una richiesta di prenotazione per la capacità di connessione e di esecuzione, anziché limitarsi a documentare l'utilizzo previsto.
Entrambi i valori dovrebbero quindi essere forniti nelle chiamate create. Se vengono omessi, vengono utilizzati i valori predefiniti di Integrazioni e API → Integration-API.
Esempio di prenotazione della capacità
L'esempio seguente mostra come la pianificazione della capacità basata sulla prenotazione cambia il comportamento rispetto alla normale ipotesi di un singolo server:
| Situazione | Effetto sulla capacità |
|---|---|
| Il tuo account consente 20 connessioni simultanee | Questo è il pool totale di connessioni disponibile per le prenotazioni attive. |
La conferenza A viene creata con maxParticipants = 15 e duration = 120 minutes | La conferenza A riserva 15 delle 20 connessioni disponibili per l'intera finestra di prenotazione di due ore. |
| Un'altra conferenza viene creata durante queste due ore | Non può riservare più delle 5 connessioni rimanenti finché la conferenza A si trova ancora nella sua finestra temporale riservata. |
| Le due ore sono trascorse e la conferenza A è ancora in corso | La conferenza A può continuare, ma la sua capacità riservata non è più garantita né protetta. |
La conferenza B viene creata successivamente con maxParticipants = 10 | Il sistema può terminare automaticamente la conferenza A a favore della conferenza B perché la conferenza A non è più protetta da una prenotazione attiva. |
Comportamento del parametro "duration"
Su bbbserver.de, duration fa parte della pianificazione della capacità e non termina automaticamente una riunione quando viene superato il tempo configurato.
Poiché duration ha questo significato di prenotazione su bbbserver.de, il superamento della durata configurata non termina mai automaticamente una riunione. Se il tuo flusso di lavoro richiede un orario di fine fisso, pianifica una chiamata API end esplicita.
Parametro aggiuntivo per il white-labeling
deactivateBbbserverDefaultChatTexts accetta true o false e il valore predefinito è false.
Finché rimane false, bbbserver.de aggiunge un proprio testo nella chat con istruzioni per l'accesso telefonico e un avviso di hosting. I tuoi testi welcome e moderatorOnlyMessage vengono aggiunti successivamente. Imposta il parametro su true se vuoi disattivare questi testi predefiniti di bbbserver per il white-labeling.
Endpoint non disponibili
Le seguenti chiamate API esistono nell'API standard, ma non sono implementate dalla IntegrationAPI:
updateRecordings, getDefaultConfigXML, setConfigXML, getRecordingTextTracks, putRecordingTextTrack
Webhook
Gli hook devono essere registrati per ID riunione specifici. La registrazione per tutte le riunioni senza specificare un ID riunione non è supportata.
Gli eventi webhook possono contenere informazioni sensibili. bbbserver.de rimuove o offusca quindi automaticamente i campi sensibili alla privacy, per cui dati come gli indirizzi IP dei partecipanti potrebbero non essere disponibili.
Limiti di frequenza
Non ci sono limiti di frequenza sul IntegrationAPI.
Oltre al IntegrationAPI, bbbserver.de offre un System API separato con funzionalità specifiche della piattaforma come gestione dell'account e statistiche di utilizzo. Il System API non è compatibile con BBB e non è trattato in questa guida.
Domande frequenti
maxParticipants e duration riservano capacità, le riunioni non vengono terminate automaticamente, deactivateBbbserverDefaultChatTexts controlla i testi della chat della piattaforma, alcuni endpoint non sono disponibili e i webhook sono specifici per riunione.