APIs Web do Owncast

As APIs web são como o código executando fora do Owncast se comunica com seu servidor via HTTP. Elas vêm em duas partes:

• Webhooks notificam sua aplicação quando algo acontece na transmissão, como a chegada de uma mensagem no chat ou a transmissão entrando ao vivo. O Owncast envia um POST HTTP para um endpoint que você hospeda.
• APIs permitem que sua aplicação envie ações de volta para o Owncast, como postar uma mensagem no chat ou atualizar o título da transmissão. As requisições são autenticadas com um token de acesso.

Para receber webhooks, crie um endpoint em qualquer servidor web, em qualquer linguagem, que aceite um POST HTTP. Cada payload de evento carrega um campo type nomeando o evento e um objeto eventData com seus detalhes.

Exemplo

Referência da API

Navegue por todos os endpoints na API lançada ou na API em desenvolvimento.

Ambiente de desenvolvimento

Hospede seu código em qualquer lugar e escreva-o em qualquer linguagem. Ele precisa ser acessível pelo seu servidor Owncast para receber webhooks e capaz de alcançar seu servidor para chamar as APIs. Enquanto desenvolve localmente, uma ferramenta de tunelamento como ngrok ou Cloudflare Tunnel fornece à sua máquina uma URL pública temporária para que o Owncast possa entregar webhooks a ela. Quando estiver pronto, mova o código para qualquer servidor ou provedor de hospedagem que preferir.

Execute seu código dentro do Owncast em vez disso

Se preferir que seu código rode dentro do servidor em vez de chamá-lo via HTTP, os plugins são a outra forma de construir. Veja maneiras de estender o Owncast para saber como as duas abordagens se comparam.