Início Rápido

Comece a usar a API External do Efflux em poucos minutos. Este guia vai te orientar na criação de uma API key e na realização da sua primeira requisição.

Pré-requisitos

• Uma conta Efflux ativa com acesso de administrador
• Acesso ao Backoffice Efflux

Começando

1. Crie uma API Key

   Faça login no Backoffice Efflux e navegue até Configurações > API Keys.

   Clique em Criar API Key e configure:

   • Nome: Um nome descritivo (ex: “Integração Produção”)
   • Escopos: Selecione as permissões necessárias
   • Expiração: Data de expiração opcional

   Salve sua API key

   A API key completa é mostrada apenas uma vez quando criada. Armazene-a de forma segura - você não poderá recuperá-la depois.

2. Faça sua primeira requisição

   Use sua API key para fazer uma requisição. Substitua SUA_API_KEY pela key que você criou:

   cURL

   curl -X GET "https://api.efflux.media/api/external/content" \
     -H "X-API-Key: SUA_API_KEY"

   JavaScript

   const response = await fetch('https://api.efflux.media/api/external/content', {
     headers: {
       'X-API-Key': 'SUA_API_KEY'
     }
   });
   const content = await response.json();
   console.log(content);

   Python

   import requests
   
   response = requests.get(
       'https://api.efflux.media/api/external/content',
       headers={'X-API-Key': 'SUA_API_KEY'}
   )
   content = response.json()
   print(content)

3. Verifique a resposta

   Uma resposta bem-sucedida retorna um array JSON com seus itens de conteúdo:

   [
     {
       "id": "550e8400-e29b-41d4-a716-446655440000",
       "name": "Vídeo de Boas-vindas",
       "type": "video",
       "mimeType": "video/mp4",
       "status": "active",
       "durationSeconds": 30,
       "thumbnailUrl": "https://storage.efflux.media/thumbnails/...",
       "storageUrl": "https://storage.efflux.media/videos/...",
       "createdAt": "2024-01-15T10:30:00Z",
       "updatedAt": "2024-01-15T10:35:00Z"
     }
   ]

Formato da API Key

As API keys do Efflux seguem um formato específico:

efflux_live_{tenant_slug}_{caracteres_aleatorios}

Exemplo: efflux_live_minhaempresa_abc123xyz789...

Este formato ajuda a identificar a qual tenant a key pertence e facilita o gerenciamento de keys entre ambientes.

Escopos Disponíveis

Ao criar uma API key, você pode selecionar entre estes escopos:

Escopo	Descrição
content:read	Listar e recuperar itens de conteúdo
schedules:read	Listar programações
players:read	Listar dispositivos player
analytics:read	Acessar dados de analytics

Dica

Solicite apenas os escopos que sua integração realmente precisa. Isso segue o princípio do menor privilégio e melhora a segurança.

Próximos Passos

Agora que você fez sua primeira requisição, explore:

• Autenticação - Saiba mais sobre autenticação via API key e escopos
• Referência da API - Documentação detalhada de todos os endpoints
• Exemplos de Código - Exemplos completos em várias linguagens