Visão Geral da API REST

A API REST do Screenzzie permite gerenciar programaticamente suas telas de sinalização digital, playlists, mídia e agendamentos. Perfeita para integrações, automação e aplicações personalizadas.

URL Base

Todos os endpoints da API estão disponíveis em:

https://www.screenzzie.com/api/v1

Autenticação

A API usa autenticação Bearer token com API keys. Inclua sua API key no header Authorization:

curl -X GET "https://www.screenzzie.com/api/v1/screens" \
  -H "Authorization: Bearer sk_live_sua_api_key_aqui" \
  -H "Content-Type: application/json"

Obtendo uma API Key

1. Vá até Configurações > API Keys no seu painel Screenzzie
2. Clique em Criar API Key
3. Escolha um nome descritivo e selecione permissões
4. Copie sua key imediatamente (ela é mostrada apenas uma vez!)

Escopos da API Key

Ao criar uma API key, você pode escolher entre três níveis de permissão:

Limites de Taxa

Requisições da API são limitadas baseado no seu plano de assinatura:

Headers de limite de taxa são incluídos em todas as respostas:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1704067200

Formato de Resposta

Todas as respostas são retornadas em formato JSON com estrutura consistente:

Resposta de Sucesso

{
  "success": true,
  "data": {
    // Dados do recurso aqui
  }
}

Resposta Paginada

{
  "success": true,
  "data": {
    "items": [...],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 100,
      "totalPages": 5,
      "hasMore": true
    }
  }
}

Resposta de Erro

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Nome é obrigatório",
    "details": { ... }
  }
}

Códigos de Erro

Endpoints Disponíveis

A API fornece os seguintes recursos:

• Telas - Gerencie suas telas de sinalização digital
• Playlists - Crie e gerencie playlists
• Mídia - Acesse e registre arquivos de mídia
• Agendamentos - Agende conteúdo (plano Growth)

Próximos Passos

• Veja a referência de Endpoints da API
• Crie sua primeira API Key no painel