Owncast 网络 API

Web API 是外部运行的代码通过 HTTP 与你的 Owncast 服务器通信的方式。 它们分为两部分：

• Webhooks（回调） 在流上发生事件时通知你的应用，例如聊天消息到达或直播开始。 Owncast 向你托管的端点发送一个 HTTP POST。
• APIs（接口） 允许你的应用向 Owncast 发送操作，例如发布聊天消息或更新流标题。 请求使用访问令牌进行身份验证。

要接收 webhooks，请在任意 Web 服务器上（使用任意语言）创建一个接受 HTTP POST 的端点。 每个事件负载都包含一个名为 type 的字段来标识事件，以及包含详细信息的 eventData 对象。

示例

API 参考

在 已发布 API 或 开发中 API 中浏览所有端点。

开发环境

可以在任何地方托管你的代码，并使用任何语言编写。 它需要能被你的 Owncast 服务器访问以接收 webhooks，并且能够访问你的服务器以调用 API。 在本地开发时，像 ngrok 或 Cloudflare Tunnel 这样的隧道工具会为你的机器提供临时的公共 URL，以便 Owncast 将 webhooks 发送到它。 准备好后，将代码迁移到你喜欢的任何服务器或托管平台。

改为在 Owncast 内运行你的代码

如果你希望代码在服务器内运行而不是通过 HTTP 调用，插件 是另一种构建方式。 参见 扩展 Owncast 的方法 了解两种方法的比较。