Players

Acesse informações sobre seus dispositivos player (displays de digital signage).

Escopo Necessário: players:read

Listar Players

Recupera todos os dispositivos player do seu tenant.

GET /api/external/players

Exemplo de Requisição

cURL

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

JavaScript

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

Python

import requests

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

Resposta

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Display Frente da Loja",
    "orientation": "landscape",
    "status": "active",
    "deviceType": "smart_tv",
    "platform": "tizen",
    "manufacturer": "Samsung",
    "model": "QN65Q80BAFXZA",
    "resolutionWidth": 3840,
    "resolutionHeight": 2160,
    "storeId": "loja-001",
    "ipAddress": "192.168.1.100",
    "timezone": "America/Sao_Paulo",
    "currentVersion": "2.1.0",
    "healthStatus": "healthy",
    "lastSeenAt": "2024-01-20T15:30:00Z",
    "createdAt": "2024-01-01T10:00:00Z",
    "updatedAt": "2024-01-20T15:30:00Z",
    "tenantId": "123e4567-e89b-12d3-a456-426614174000"
  }
]

---

Objeto de Player

Campo	Tipo	Descrição
id	UUID	Identificador único
name	string	Nome de exibição
orientation	string	Orientação da tela: landscape ou portrait
status	string	Status do player
deviceType	string	Tipo de dispositivo
platform	string	Sistema operacional/plataforma
manufacturer	string	Fabricante do dispositivo
model	string	Modelo do dispositivo
resolutionWidth	inteiro	Largura da tela em pixels
resolutionHeight	inteiro	Altura da tela em pixels
storeId	string	Identificador da loja/localização
ipAddress	string	Último endereço IP conhecido
timezone	string	Timezone IANA (ex: America/Sao_Paulo)
currentVersion	string	Versão instalada do app player
healthStatus	string	Status de saúde do dispositivo
lastSeenAt	datetime	Timestamp da última comunicação
createdAt	datetime	Timestamp de registro
updatedAt	datetime	Timestamp da última atualização
tenantId	UUID	Identificador do tenant

Status do Player

Status	Descrição
active	Player está operacional e recebendo conteúdo
blocked	Player foi desabilitado pelo administrador

Tipos de Dispositivo

Tipo	Descrição
smart_tv	Smart TV com player integrado
media_player	Dispositivo media player dedicado
tablet	Dispositivo tablet
browser	Player baseado em navegador web

Plataformas

Plataforma	Descrição
tizen	Samsung Tizen OS
webos	LG webOS
android	Dispositivos Android
web	Navegador web

Status de Saúde

Status	Descrição
healthy	Dispositivo está funcionando normalmente
warning	Dispositivo tem problemas menores
critical	Dispositivo tem problemas significativos
offline	Dispositivo não se comunicou recentemente

Dica

Use lastSeenAt para determinar se um player está se comunicando ativamente. Players tipicamente fazem check-in a cada poucos minutos. Um lastSeenAt mais antigo que 10-15 minutos pode indicar problemas de conectividade.

Monitorando Players

Para construir um dashboard de monitoramento de players, você pode:

1. Listar todos os players para obter o estado atual
2. Verificar healthStatus para saúde do dispositivo
3. Monitorar lastSeenAt para conectividade
4. Filtrar por status para encontrar dispositivos desabilitados

Exemplo: Encontrando Players Offline

const players = await fetchPlayers();
const quinzeMinutosAtras = new Date(Date.now() - 15 * 60 * 1000);

const playersOffline = players.filter(player =>
  new Date(player.lastSeenAt) < quinzeMinutosAtras
);

console.log(`${playersOffline.length} players parecem estar offline`);