API BBB (compat-api)

Le module compat-api expose une API HTTP compatible BigBlueButton. Il permet à une plateforme d’apprentissage (LMS) comme Moodle ou Greenlight de créer et de gérer des réunions Vuisio, sans rien changer côté LMS.

Installation

vuisio module add compat-api

Disponible en runtime Docker comme en natif. Gratuit, aucun jeton requis.

Brancher un LMS

Dans votre LMS, configurez le connecteur BigBlueButton avec deux informations :

• URL de l’API : https://<votre-domaine>/bigbluebutton/api/

• Secret partagé : la valeur de COMPAT_API_SHARED_SECRET, que vous récupérez avec :

  vuisio secrets show --reveal COMPAT_API_SHARED_SECRET

Les requêtes sont authentifiées par une somme de contrôle SHA-256, exactement comme avec BigBlueButton.

Ce que le LMS peut faire

Une fois branché, le LMS pilote les réunions par l’API : créer une réunion, y faire entrer un participant (avec son rôle), la terminer, savoir si elle est en cours, lister les réunions et récupérer leurs informations. Lorsqu’un participant rejoint depuis le LMS, il est redirigé vers la salle Vuisio sans avoir à saisir quoi que ce soit.

Sans LMS : API Mate

Pour créer et piloter des réunions à la main (pratique en pré-version, avant d’avoir un LMS ou le futur module lobby), utilisez API Mate : renseignez l’URL de l’API et le secret partagé, et l’outil construit les appels à votre place.

Configuration

Outre le secret partagé, les options se règlent dans room-defaults.toml sous [modules.compat-api] (par exemple la politique d’admission des invités). L’URL de redirection vers le client web et le répertoire de stockage de l’état des réunions sont configurés à l’installation.