Capítulo 24

bbbserver.de IntegrationAPI

El IntegrationAPI en bbbserver.de es un proxy que refleja la API estándar de BigBlueButton mientras distribuye las conferencias en segundo plano entre varios servidores con capacidad suficiente.

Dónde encontrar la URL de la API y el secreto compartido

Tu URL de API y shared secret están disponibles en el panel de administración de bbbserver, en Integraciones y APIs → Integration-API. Allí también se puede activar o desactivar IntegrationAPI.

No necesitas acceso shell ni comandos de bbb-conf para recuperar las credenciales cuando usas bbbserver.de.

Compatibilidad de Plugin

Las siguientes plataformas funcionan de inmediato. En la mayoría de los casos, solo necesitas introducir la URL de la API y shared secret en la integración estándar de BigBlueButton.

  • Moodle (BigBlueButtonBN)
  • ILIAS
  • Nextcloud
  • WordPress
  • Greenlight

Diferencias con la API estándar

El IntegrationAPI refleja de cerca la API estándar de BBB, pero varios comportamientos en bbbserver.de son lo bastante diferentes como para que deban entenderse explícitamente durante la integración.

Reserva de capacidad

Cuando creas una conferencia mediante IntegrationAPI, bbbserver.de debe asignarla a un servidor backend con suficientes recursos disponibles. Por eso, maxParticipants y duration actúan como una solicitud de reserva de capacidad de conexión y de ejecución, en lugar de limitarse a documentar el uso previsto.

Por lo tanto, ambos valores deberían proporcionarse en las llamadas a create. Si se omiten, se usan los valores predeterminados de Integraciones y APIs → Integration-API.

Ejemplo de reserva de capacidad

El siguiente ejemplo muestra cómo la planificación de capacidad basada en reservas cambia el comportamiento en comparación con la suposición habitual de un único servidor:

Situación Efecto en la capacidad
Tu cuenta permite 20 conexiones simultáneas Este es el total de conexiones disponible para reservas activas.
La conferencia A se crea con maxParticipants = 15 y duration = 120 minutes La conferencia A reserva 15 de las 20 conexiones disponibles durante toda la ventana de reserva de dos horas.
Se crea otra conferencia durante esas dos horas No puede reservar más de las 5 conexiones restantes mientras la conferencia A siga dentro de su ventana de tiempo reservada.
Las dos horas han terminado y la conferencia A sigue en ejecución La conferencia A puede continuar, pero su capacidad reservada ya no está garantizada ni protegida.
Más tarde se crea la conferencia B con maxParticipants = 10 El sistema puede finalizar automáticamente la conferencia A en favor de la conferencia B porque la conferencia A ya no está protegida por una reserva activa.

Comportamiento del parámetro "duration"

En bbbserver.de, duration forma parte de la planificación de capacidad y no finaliza automáticamente una reunión cuando se supera el tiempo configurado.

Como duration tiene este significado de reserva en bbbserver.de, superar la duración configurada nunca finaliza una reunión automáticamente. Si tu flujo de trabajo requiere una hora de finalización fija, programa una llamada explícita a la API end.

Parámetro adicional para marca blanca

deactivateBbbserverDefaultChatTexts acepta true o false y el valor predeterminado es false.

Mientras siga siendo false, bbbserver.de añade su propio texto de chat con instrucciones de marcación y un aviso de alojamiento. Tus textos welcome y moderatorOnlyMessage se añaden después. Establece el parámetro en true si quieres desactivar esos textos predeterminados de bbbserver para marca blanca.

Endpoints no disponibles

Las siguientes llamadas a la API existen en la API estándar, pero no están implementadas por la IntegrationAPI:

updateRecordings, getDefaultConfigXML, setConfigXML, getRecordingTextTracks, putRecordingTextTrack

Webhooks

Los hooks deben registrarse para IDs de reunión específicos. No se admite el registro para todas las reuniones sin especificar un ID de reunión.

Los eventos de webhook pueden contener información sensible. Por lo tanto, bbbserver.de elimina u ofusca automáticamente los campos sensibles desde el punto de vista de la privacidad, por lo que datos como las direcciones IP de los participantes pueden no estar disponibles.

Límites de tasa

No hay límites de tasa en IntegrationAPI.

Además de IntegrationAPI, bbbserver.de ofrece una System API independiente con funciones específicas de la plataforma, como gestión de cuentas y estadísticas de uso. System API no es compatible con BBB y no se trata en esta guía.

Preguntas frecuentes

Abre el panel de administración de bbbserver y navega a Integraciones y APIs → Integration-API. Allí puedes ver la URL de la API, copiar shared secret y activar o desactivar IntegrationAPI.

IntegrationAPI está diseñado para funcionar con integraciones estándar de BigBlueButton como Moodle, ILIAS, Nextcloud, WordPress y Greenlight.

La bbbserver.de de IntegrationAPI refleja la API estándar de BBB, pero maxParticipants y duration reservan capacidad, las reuniones no finalizan automáticamente, deactivateBbbserverDefaultChatTexts controla los textos del chat de la plataforma, algunos endpoints no están disponibles y los webhooks son específicos de cada reunión.

Puedes activar temporalmente el registro de solicitudes. Mientras esté activo, se registran todas las solicitudes enviadas a IntegrationAPI. Esto te permite probar la propia API, probar tu propia integración e inspeccionar cómo se comporta la API en la práctica.