Owncast の Web API

Web API は、Owncast の外で動作するコードが HTTP 経由であなたのサーバーとやり取りする方法です。 それらは二つの半分に分かれています：

• ウェブフック は、チャットメッセージの到着や配信の開始など、ストリーム上で何かが起きたときにあなたのアプリケーションに通知します。 Owncast はあなたがホストするエンドポイントに HTTP POST を送信します。
• API により、チャットメッセージを投稿したりストリームのタイトルを更新したりするなど、あなたのアプリケーションが Owncast にアクションを送ることができます。 リクエストはアクセストークンで認証されます。

ウェブフックを受け取るには、任意の言語で任意のウェブサーバー上に HTTP POST を受け付けるエンドポイントを作成してください。 各イベントペイロードは、イベントを示す type フィールドと詳細を含む eventData オブジェクトを持ちます。

例

API リファレンス

すべてのエンドポイントは リリース版 API または 開発中 API で参照できます。

開発環境

コードはどこにでもホストでき、任意の言語で記述できます。 ウェブフックを受け取るには Owncast サーバーから到達可能である必要があり、API を呼び出すにはあなたのサーバーにアクセスできる必要があります。 ローカルで開発している間は、ngrok や Cloudflare Tunnel のようなトンネリングツールを使うと、マシンに一時的な公開 URL が与えられ、Owncast がそこへウェブフックを配信できます。 準備ができたら、コードを任意のサーバーやホスティングプラットフォームに移してください。

代わりに Owncast 内でコードを実行する

HTTP で呼び出す代わりにコードをサーバー内で実行したい場合、プラグイン がもう一つの構築方法です。 両者の比較については Owncast を拡張する方法 を参照してください。