API Web d'Owncast

Les APIs web sont la manière dont le code s'exécutant en dehors d'Owncast communique avec votre serveur via HTTP. Ils viennent en deux parties :

• Webhooks notifient votre application lorsqu'un événement se produit sur le flux, comme l'arrivée d'un message dans le chat ou le lancement du flux. Owncast envoie un HTTP POST à un point de terminaison que vous hébergez.
• APIs permettent à votre application d'envoyer des actions dans Owncast, comme publier un message dans le chat ou mettre à jour le titre du flux. Les requêtes sont authentifiées par un jeton d'accès.

Pour recevoir des webhooks, créez un point de terminaison sur n'importe quel serveur web, dans n'importe quel langage, qui accepte un HTTP POST. Chaque charge utile d'événement transporte un champ type nommé l'événement et un objet eventData avec ses détails.

Exemple

Référence API

Parcourez chaque point de terminaison dans l'API publiée ou l'API en développement.

Environnement de développement

Hébergez votre code n'importe où et écrivez-le dans n'importe quel langage. Il doit être accessible par votre serveur Owncast pour recevoir des webhooks, et capable d'atteindre votre serveur pour appeler les APIs. Lors du développement local, un outil de tunneling comme ngrok ou Cloudflare Tunnel donne à votre machine une URL publique temporaire afin qu'Owncast puisse livrer les webhooks à celle-ci. Lorsque vous êtes prêt, déplacez le code vers n'importe quel serveur ou plateforme d'hébergement de votre choix.

Exécutez votre code à l'intérieur d'Owncast à la place

Si vous préférez que votre code s'exécute à l'intérieur du serveur plutôt que de l'appeler via HTTP, plugins sont l'autre manière de construire. Voir les façons d'étendre Owncast pour comparer les deux approches.