Веб-API Owncast

Веб-API — это способ, которым код, выполняющийся вне Owncast, взаимодействует с вашим сервером по HTTP. Они делятся на две части:

• Вебхуки уведомляют ваше приложение о событиях на стриме, например о поступлении сообщения в чате или о начале трансляции. Owncast отправляет HTTP POST на endpoint, размещённый вами.
• API позволяют вашему приложению отправлять действия обратно в Owncast, например публиковать сообщение в чате или обновлять заголовок трансляции. Запросы аутентифицируются с помощью токена доступа.

Чтобы получать вебхуки, создайте endpoint на любом веб‑сервере на любом языке, который принимает HTTP POST. Каждая полезная нагрузка события содержит поле type, указывающее имя события, и объект eventData с его деталями.

Пример

Справочник API

Просмотрите все конечные точки в релизном API или в API в разработке.

Среда разработки

Размещайте код где угодно и пишите на любом языке. Он должен быть доступен серверу Owncast для получения вебхуков и иметь возможность обращаться к вашему серверу для вызова API. При локальной разработке инструмент туннелирования, такой как ngrok или Cloudflare Tunnel, даёт вашей машине временный публичный URL, чтобы Owncast мог доставлять на него вебхуки. Когда будете готовы, переместите код на любой сервер или платформу хостинга по вашему выбору.

Запустите код внутри Owncast вместо этого

Если вы предпочитаете запускать код внутри сервера, а не вызывать его по HTTP, плагины — это другой способ разработки. См. способы расширения Owncast, чтобы узнать, как соотносятся эти два подхода.