A API de sinal
A API Signal de Voco permite que dispositivos externos enviem comandos para o stream ativo sem abrir o painel de administração. Está disponível nos planos Voco Pro e Network.
A API oferece suporte a cinco ações: stream:start, stream:stop, captions:clear, captions:hide e captions:show.
Configuração de Stream Deck (ação de URL)
Para ferramentas que suportam cabeçalhos HTTP personalizados, use POST com um cabeçalho de autorização. Isso mantém sua chave de API fora de URLs, histórico do navegador e logs do servidor.
O botão básico do site de Stream Deck ainda pode usar um gatilho de URL quando nenhuma ação baseada em cabeçalho estiver disponível, mas trate o perfil desse botão como uma senha e gire a chave se ela for compartilhada.
- 1Encontre sua chave de APIAbra Configurações → API no painel Voco e copie a chave API da sua igreja.
- 2Use uma ação compatível com cabeçalho sempre que possívelDefina o método como POST, o URL como https://voco.church/api/v1/signal e adicione Autorização: Bearer YOUR_KEY.
- 3Envie a açãoEnvie JSON como { "action": "stream:start" } para cada botão.
- 4Apenas substituto: gatilho de URLSe sua ferramenta não puder enviar cabeçalhos, use o formato de URL abaixo e mantenha o perfil Stream Deck privado.
- 5Repita para cada açãoCrie um botão por ação – iniciar, parar, ativar/desativar legendas, limpar.
Companheiro Bitfocus
O Bitfocus Companion oferece suporte a ações de solicitação HTTP, que funcionam com o endpoint POST da API Signal. Use um botão Solicitação HTTP genérica e defina o método como POST, o URL como https://voco.church/api/v1/signal e envie um cabeçalho de autorização ou um corpo JSON com sua chave de API e ação.
O Companion é útil quando você precisa de um controlador de grade de botões completo em vez de um consumidor Stream Deck, ou ao integrar fluxos de trabalho de controle ATEM, vMix ou ProPresenter.
ProPresenter ações de URL
Os slides ProPresenter podem disparar ações de URL quando exibidos. Adicione uma ação de URL a qualquer slide usando o endpoint GET da API Signal - por exemplo, um slide pré-serviço que inicia o fluxo Voco automaticamente quando é colocado na tela.
Mantenha sua chave de API privada
Não cole sua chave de API em documentos compartilhados, bate-papos em grupos de voluntários ou gravações de transmissões ao vivo. As ferramentas acionadoras de URL podem armazenar a chave em sua configuração, portanto, mantenha esses arquivos privados e gire a chave em Configurações → API se ela estiver exposta.