bbbserver.de IntegrationAPI
Le IntegrationAPI sur bbbserver.de est un proxy qui reproduit l’API BigBlueButton standard tout en répartissant les conférences en arrière-plan sur plusieurs serveurs disposant de suffisamment de capacité.
bbbserver.de est une plateforme d’hébergement premium basée dans l’UE pour BigBlueButton, avec des serveurs situés dans l’UE. Les applications externes se connectent via l’API BBB familière et se comportent comme si elles communiquaient avec un seul serveur.
Où trouver l’URL API et le secret partagé
Votre URL API et votre shared secret sont disponibles dans le panneau d’administration bbbserver sous Intégrations & API → Integration-API. Le IntegrationAPI peut également y être activé ou désactivé.
Vous n’avez pas besoin d’un accès shell ni des commandes bbb-conf pour récupérer les identifiants lorsque vous utilisez bbbserver.de.
Compatibilité Plugin
Les plateformes suivantes fonctionnent immédiatement. Dans la plupart des cas, il vous suffit de saisir l’URL API et le shared secret dans l’intégration BigBlueButton standard.
- Moodle (BigBlueButtonBN)
- ILIAS
- Nextcloud
- WordPress
- Greenlight
Différences par rapport à l'API standard
Le IntegrationAPI reproduit de près l’API BBB standard, mais plusieurs comportements sur bbbserver.de sont suffisamment différents pour devoir être compris explicitement lors de l’intégration.
Réservation de capacité
Lorsque vous créez une conférence via le IntegrationAPI, bbbserver.de doit l’attribuer à un serveur backend disposant de suffisamment de ressources restantes. C’est pourquoi maxParticipants et duration agissent comme une demande de réservation pour la capacité de connexion et d’exécution, plutôt que de simplement documenter l’utilisation attendue.
Les deux valeurs doivent donc être fournies lors des appels create. Si elles sont omises, les valeurs par défaut de Intégrations & API → Integration-API sont utilisées.
Exemple de réservation de capacité
L’exemple suivant montre comment une planification de capacité basée sur des réservations modifie le comportement par rapport à l’hypothèse normale d’un seul serveur :
| Situation | Effet sur la capacité |
|---|---|
| Votre compte autorise 20 connexions simultanées | Il s’agit du pool total de connexions disponible pour les réservations actives. |
La conférence A est créée avec maxParticipants = 15 et duration = 120 minutes | La conférence A réserve 15 des 20 connexions disponibles pour toute la fenêtre de réservation de deux heures. |
| Une autre conférence est créée pendant ces deux heures | Elle ne peut pas réserver plus que les 5 connexions restantes tant que la conférence A est encore dans sa fenêtre de temps réservée. |
| Les deux heures sont écoulées et la conférence A est toujours en cours | La conférence A peut continuer, mais sa capacité réservée n’est plus garantie ni protégée. |
La conférence B est créée plus tard avec maxParticipants = 10 | Le système peut automatiquement mettre fin à la conférence A en faveur de la conférence B, car la conférence A n’est plus protégée par une réservation active. |
Comportement du paramètre « duration »
Sur bbbserver.de, duration fait partie de la planification de la capacité et ne met pas automatiquement fin à une réunion lorsque la durée configurée est dépassée.
Étant donné que duration a cette signification de réservation sur bbbserver.de, le dépassement de la durée configurée ne met jamais automatiquement fin à une réunion. Si votre flux de travail nécessite une heure de fin fixe, planifiez un appel API end explicite.
Paramètre supplémentaire pour le white-label
deactivateBbbserverDefaultChatTexts accepte true ou false et la valeur par défaut est false.
Tant qu’il reste à false, bbbserver.de ajoute son propre texte de chat avec les instructions de connexion téléphonique et une mention d’hébergement. Vos textes welcome et moderatorOnlyMessage sont ensuite ajoutés. Définissez le paramètre sur true si vous souhaitez désactiver ces textes bbbserver par défaut pour le white-label.
Points de terminaison indisponibles
Les appels API suivants existent dans l’API standard, mais ne sont pas implémentés par l’IntegrationAPI :
updateRecordings, getDefaultConfigXML, setConfigXML, getRecordingTextTracks, putRecordingTextTrack
Webhooks
Les hooks doivent être enregistrés pour des identifiants de réunion spécifiques. L’enregistrement pour toutes les réunions sans préciser d’identifiant de réunion n’est pas pris en charge.
Les événements webhook peuvent contenir des informations sensibles. bbbserver.de supprime donc ou obscurcit automatiquement les champs sensibles du point de vue de la vie privée, de sorte que des données telles que les adresses IP des participants peuvent être indisponibles.
Limites de débit
Il n’y a pas de limites de débit sur le IntegrationAPI.
En plus de l'IntegrationAPI, bbbserver.de propose une System API distincte avec des fonctionnalités spécifiques à la plateforme telles que la gestion des comptes et les statistiques d'utilisation. La System API n'est pas compatible avec BBB et n'est pas couverte dans ce guide.
Foire aux questions
maxParticipants et duration réservent la capacité, les réunions ne se terminent pas automatiquement, deactivateBbbserverDefaultChatTexts contrôle les textes du chat de la plateforme, certains points de terminaison sont indisponibles et les webhooks sont spécifiques à chaque réunion.