APIs Web de Owncast

Las APIs web son la forma en que el código que se ejecuta fuera de Owncast se comunica con tu servidor a través de HTTP. Vienen en dos mitades:

• Webhooks notifican a tu aplicación cuando sucede algo en la transmisión, como la llegada de un mensaje de chat o la transmisión en vivo. Owncast envía un POST HTTP a un endpoint que tú hospedas.
• APIs permiten que tu aplicación envíe acciones de regreso a Owncast, como publicar un mensaje de chat o actualizar el título de la transmisión. Las solicitudes se autentican con un token de acceso.

Para recibir webhooks, crea un endpoint en cualquier servidor web, en cualquier idioma, que acepte un POST HTTP. Cada carga útil de evento lleva un campo type que nombra el evento y un objeto eventData con sus detalles.

Ejemplo

Referencia de API

Explora cada endpoint en la API publicada o en la API en desarrollo.

Entorno de desarrollo

Aloja tu código en cualquier lugar y escríbelo en cualquier idioma. Necesita ser accesible por tu servidor Owncast para recibir webhooks, y capaz de alcanzar tu servidor para llamar a las APIs. Mientras desarrollas localmente, una herramienta de tunelización como ngrok o Cloudflare Tunnel le da a tu máquina una URL pública temporal para que Owncast pueda entregar webhooks a ella. Cuando estés listo, mueve el código a cualquier servidor o plataforma de hosting que desees.

Ejecuta tu código dentro de Owncast en su lugar

Si prefieres que tu código se ejecute dentro del servidor en lugar de llamarlo a través de HTTP, plugins son la otra forma de construir. Consulta maneras de extender Owncast para ver cómo se comparan los dos enfoques.