Skip to Content
DocumentationAPI ReferenceTransmissões ao Vivo

Transmissões ao Vivo API

As transmissões ao vivo API fornecem endpoints para descobrir e recuperar informações sobre seus eventos ao vivo. Isso permite que você construa diretórios “Ao Vivo Agora” e embute jogadores ao vivo em suas aplicações.

Obter Transmissões Ao Vivo Ativas

Este é o endpoint principal para descobrir streams que estão atualmente “em transmissão”. Ele retorna uma lista apenas com os streams que estão ativamente recebendo sinal de um encoder.

GET /transmissões-ao-vivo/ativas

Parâmetros

Este endpoint não recebe nenhum parâmetro. Ele retornará todos os streams ativos para sua conta.

Exemplo de Solicitação

GET /api/cliente/v1/transmissões-ao-vivo/ativas
Host: https://sua-aplicação.com
Autorização: Bearer sk-sua-chave-de-autenticação-aqui

Resposta: GET /transmissões-ao-vivo/ativas

Se os streams estiverem ativos, você receberá uma matriz de objetos LiveStream. O status será ativo e um objeto manifest estará presente.

Resposta: 200 OK (Streams Ativos)
{
  "data": [
    {
      "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
      "title": "Sessão de Perguntas e Respostas Semanal",
      "description": "Respondo às suas perguntas ao vivo.",
      "status": "ativo",
      "manifest": {
        "hls_url": "https://sua-aplicação.com/armazenamento/transmissões-ao-vivo/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptativo/master.m3u8"
      },
      "metadata": {
        "categoria": "Tecnologia",
        "anfitrião": "Jane Doe"
      },
      "tags": ["ao vivo", "q&a"],
      "created_at": "2024-08-01T10:00:00Z"
    }
  ]
}

Se nenhum stream estiver atualmente ativo, a API retornará uma matriz vazia.

Resposta: 200 OK (Nenhum Stream Ativo)
{
  "data": []
}

Obter Todas as Transmissões Ao Vivo

Este endpoint fornece um diretório paginado de todas as transmissões ao vivo configuradas em sua conta, independentemente do seu status atual (ativo ou inativo). Isso é útil para construir uma programação ou uma lista completa de canais disponíveis.

GET /transmissões-ao-vivo

Parâmetros

NomeTipoObrigatórioDescrição
por_paginainteiroOpcionalO número de streams a retornar por página. Padrão: 15, Máximo: 100.

Exemplo de Solicitação

GET /api/cliente/v1/transmissões-ao-vivo?por_pagina=2

Resposta: GET /transmissões-ao-vivo

A resposta é uma lista padrão paginada. O status será ativo ou inativo, e o objeto manifest estará presente apenas para streams ativos.

Resposta: 200 OK
{
  "data": [
    {
      "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
      "title": "Sessão de Perguntas e Respostas Semanal",
      "description": "Respondo às suas perguntas ao vivo.",
      "status": "ativo",
      "manifest": {
        "hls_url": "https://sua-aplicação.com/armazenamento/transmissões-ao-vivo/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptativo/master.m3u8"
      },
      "metadata": {
        "categoria": "Tecnologia"
      },
      "tags": ["ao vivo", "q&a"],
      "created_at": "2024-08-01T10:00:00Z"
    },
    {
      "id": "9c1a9e3e-1a2b-3c4d-5e6f-7g8h9i0j1k2l",
      "title": "Lançamento de Produto Futuro",
      "description": "Junte-se a nós para o grande anúncio.",
      "status": "inativo",
      "metadata": {
        "categoria": "Produto"
      },
      "tags": ["lançamento", "evento"],
      "created_at": "2024-07-25T15:00:00Z"
    }
  ],
  "links": {
    "primeiro": "https://sua-aplicação.com/api/cliente/v1/transmissões-ao-vivo?page=1",
    "último": "https://sua-aplicação.com/api/cliente/v1/transmissões-ao-vivo?page=3",
    "anterior": null,
    "próximo": "https://sua-aplicação.com/api/cliente/v1/transmissões-ao-vivo?page=2"
  },
  "meta": {
    "página atual": 1,
    "desde": 1,
    "última página": 3,
    "caminho": "https://sua-aplicação.com/api/cliente/v1/transmissões-ao-vivo",
    "por_pagina": 2,
    "até": 2,
    "total": 6
  }
}

Obter uma Transmissão Ao Vivo Individual

Recupera os detalhes completos para uma transmissão ao vivo específica por seu ID. Este é o endpoint que você chamará para obter as informações necessárias para carregar um stream em um jogador.

GET /transmissões-ao-vivo/{streamId}

Parâmetros de Caminho

NomeTipoDescrição
streamIduuidObrigatório. O identificador único da transmissão ao vivo.

Exemplo de Solicitação

GET /api/cliente/v1/transmissões-ao-vivo/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f

Resposta: GET /transmissões-ao-vivo/{streamId}

A resposta é um objeto LiveStream único. O manifest estará presente se o stream estiver ativo.

Resposta: 200 OK (Stream está Ativo)
{
  "data": {
    "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
    "title": "Sessão de Perguntas e Respostas Semanal",
    "description": "Respondo às suas perguntas ao vivo.",
    "status": "ativo",
    "manifest": {
      "hls_url": "https://sua-aplicação.com/armazenamento/transmissões-ao-vivo/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptativo/master.m3u8"
    },
    "metadata": {
      "categoria": "Tecnologia",
      "anfitrião": "Jane Doe"
    },
    "tags": ["ao vivo", "q&a"],
    "created_at": "2024-08-01T10:00:00Z"
  }
}
VídeosUploads de Vídeo