Referência de Endpoints da API

Documentação completa para todos os endpoints da API REST disponíveis.

Organização e Introspecção

Obtenha informações sobre seu contexto atual de API e organização.

Obter Contexto Atual

GET /api/v1/me

Retorna informações sobre sua API key, organização, limites de taxa e recursos disponíveis. Este endpoint não conta contra seu limite de taxa.

Exemplo de Requisição:

curl -X GET "https://www.screenzzie.com/api/v1/me" \
  -H "Authorization: Bearer sk_live_xxx"

Exemplo de Resposta:

{
  "success": true,
  "data": {
    "apiKey": {
      "id": "uuid",
      "name": "Minha API Key",
      "keyPrefix": "sk_live_abc123",
      "scopes": ["screens:read", "screens:write", "playlists:read"],
      "expiresAt": null,
      "lastUsedAt": "2024-01-15T10:30:00Z"
    },
    "organization": {
      "id": "uuid",
      "name": "Minha Empresa",
      "planId": "growth",
      "subscriptionStatus": "active",
      "trialEndsAt": null,
      "maxScreensAllowed": 50,
      "activeScreensCount": 12
    },
    "rateLimits": {
      "limit": 100000,
      "used": 45,
      "remaining": 99955,
      "resetAtMs": 1704153600000
    },
    "features": {
      "sequences": true,
      "schedules": true,
      "api": true
    }
  }
}

Listar Organizações

GET /api/v1/organizations

Retorna as organizações acessíveis com sua API key. Atualmente, cada API key pertence a exatamente uma organização.

Parâmetros de Query:

Exemplo de Requisição:

curl -X GET "https://www.screenzzie.com/api/v1/organizations" \
  -H "Authorization: Bearer sk_live_xxx"

Exemplo de Resposta:

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "uuid",
        "name": "Minha Empresa",
        "planId": "growth",
        "subscriptionStatus": "active",
        "maxScreensAllowed": 50,
        "activeScreensCount": 12,
        "createdAt": "2024-01-01T00:00:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 1,
      "totalPages": 1,
      "hasMore": false
    }
  }
}

---

Telas

Gerencie suas telas de sinalização digital.

Listar Telas

GET /api/v1/screens

Parâmetros de Query:

Exemplo de Requisição:

curl -X GET "https://www.screenzzie.com/api/v1/screens?isOnline=true&limit=10" \
  -H "Authorization: Bearer sk_live_xxx"

Exemplo de Resposta:

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "uuid",
        "name": "Display do Lobby",
        "description": "Tela da entrada principal",
        "isActive": true,
        "isOnline": true,
        "lastSeenAt": "2024-01-01T12:00:00Z",
        "orientation": "landscape",
        "rotation": "0",
        "timezone": "Europe/Madrid",
        "location": "Prédio A, Andar 1",
        "cityName": "Madrid",
        "latitude": 40.4168,
        "longitude": -3.7038,
        "workspaceId": "uuid",
        "screenGroupId": null,
        "currentPlaylistId": "uuid",
        "currentSequenceId": null,
        "defaultPlaylistId": "uuid",
        "defaultSequenceId": null,
        "createdAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-01T12:00:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 10,
      "total": 25,
      "totalPages": 3,
      "hasMore": true
    }
  }
}

Obter Tela

GET /api/v1/screens/:screenId

Parâmetros de Path:

Exemplo de Resposta:

Retorna um único objeto de tela com a mesma estrutura da resposta de lista.

Criar Tela

POST /api/v1/screens

Corpo da Requisição:

Exemplo de Requisição:

curl -X POST "https://www.screenzzie.com/api/v1/screens" \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sala de Conferência A",
    "orientation": "landscape",
    "rotation": "0",
    "timezone": "Europe/Madrid",
    "location": "Prédio B, Sala 101"
  }'

Exemplo de Resposta:

{
  "success": true,
  "data": {
    "id": "uuid",
    "name": "Sala de Conferência A",
    "description": null,
    "isActive": true,
    "isOnline": false,
    "lastSeenAt": null,
    "orientation": "landscape",
    "rotation": "0",
    "timezone": "Europe/Madrid",
    "location": "Prédio B, Sala 101",
    "cityName": null,
    "latitude": null,
    "longitude": null,
    "workspaceId": null,
    "screenGroupId": null,
    "currentPlaylistId": null,
    "currentSequenceId": null,
    "defaultPlaylistId": null,
    "defaultSequenceId": null,
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z"
  }
}

Atualizar Tela

PATCH /api/v1/screens/:screenId

Todos os campos são opcionais. Inclua apenas campos que deseja atualizar.

Corpo da Requisição:

Exemplo de Requisição:

curl -X PATCH "https://www.screenzzie.com/api/v1/screens/abc123" \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Nome do Display Atualizado",
    "currentPlaylistId": "playlist-uuid"
  }'

---

Playlists

Gerencie playlists de conteúdo para suas telas.

Listar Playlists

GET /api/v1/playlists

Parâmetros de Query:

Exemplo de Resposta:

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "uuid",
        "name": "Conteúdo Principal",
        "description": "Playlist principal para telas do lobby",
        "itemCount": 5,
        "totalDuration": 120,
        "workspaceId": null,
        "createdBy": "user-uuid",
        "createdAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-01T12:00:00Z"
      }
    ],
    "pagination": { ... }
  }
}

Obter Playlist

GET /api/v1/playlists/:playlistId

Retorna a playlist com seus itens. Itens são sempre incluídos na resposta.

Parâmetros de Path:

Exemplo de Resposta:

{
  "success": true,
  "data": {
    "id": "uuid",
    "name": "Conteúdo Principal",
    "description": "Playlist principal para telas do lobby",
    "itemCount": 2,
    "totalDuration": 45,
    "workspaceId": null,
    "createdBy": "user-uuid",
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T12:00:00Z",
    "items": [
      {
        "id": "item-uuid-1",
        "position": 0,
        "duration": 15,
        "itemType": "media",
        "mediaId": "media-uuid",
        "config": null,
        "createdAt": "2024-01-01T00:00:00Z"
      },
      {
        "id": "item-uuid-2",
        "position": 1,
        "duration": 30,
        "itemType": "website",
        "mediaId": null,
        "config": { "url": "https://example.com" },
        "createdAt": "2024-01-01T00:00:00Z"
      }
    ]
  }
}

Criar Playlist

POST /api/v1/playlists

Corpo da Requisição:

Exemplo de Requisição:

curl -X POST "https://www.screenzzie.com/api/v1/playlists" \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Promoções de Feriado",
    "description": "Conteúdo sazonal para dezembro"
  }'

Atualizar Playlist

PATCH /api/v1/playlists/:playlistId

Corpo da Requisição:

Excluir Playlist

DELETE /api/v1/playlists/:playlistId

Retorna 204 No Content em caso de sucesso.

---

Mídia

Acesse e registre arquivos de mídia na sua biblioteca.

Listar Mídia

GET /api/v1/media

Parâmetros de Query:

Exemplo de Resposta:

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "uuid",
        "name": "video-promo.mp4",
        "type": "video",
        "fileUrl": "https://...",
        "thumbnailUrl": "https://...",
        "fileSize": 15728640,
        "duration": 30,
        "folderId": null,
        "workspaceId": null,
        "uploadedBy": "user-uuid",
        "createdAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-01T00:00:00Z"
      }
    ],
    "pagination": { ... }
  }
}

Obter Mídia

GET /api/v1/media/:mediaId

Retorna um único objeto de mídia com a mesma estrutura da resposta de lista.

Registrar Mídia

POST /api/v1/media

Registra um arquivo de mídia que já foi enviado para o storage. Este endpoint não lida com uploads de arquivo diretamente - use o painel web para uploads de arquivo.

Corpo da Requisição:

Exemplo de Requisição:

curl -X POST "https://www.screenzzie.com/api/v1/media" \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Logo da Empresa",
    "type": "image",
    "fileUrl": "https://seu-storage.com/logo.png",
    "thumbnailUrl": "https://seu-storage.com/logo-thumb.png",
    "fileSize": 102400
  }'

Excluir Mídia

DELETE /api/v1/media/:mediaId

Retorna 204 No Content em caso de sucesso.

---

Agendamentos

Agende conteúdo para reproduzir em horários específicos.

Listar Agendamentos

GET /api/v1/schedules

Parâmetros de Query:

Exemplo de Resposta:

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "uuid",
        "name": "Promoções de Fim de Semana",
        "playlistId": "playlist-uuid",
        "sequenceId": null,
        "screenId": null,
        "screenGroupId": null,
        "targetType": "all_screens",
        "dayOfWeek": [0, 6],
        "startTime": "09:00",
        "endTime": "21:00",
        "startDate": null,
        "endDate": null,
        "priority": 10,
        "isActive": true,
        "color": "#3B82F6",
        "workspaceId": null,
        "createdAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-01T00:00:00Z"
      }
    ],
    "pagination": { ... }
  }
}

Obter Agendamento

GET /api/v1/schedules/:scheduleId

Retorna um único objeto de agendamento com a mesma estrutura da resposta de lista.

Criar Agendamento

POST /api/v1/schedules

Corpo da Requisição:

*Ou playlistId ou sequenceId deve ser fornecido para agendar conteúdo.

Requisitos Condicionais por Tipo de Alvo:

Exemplo de Requisição:

curl -X POST "https://www.screenzzie.com/api/v1/schedules" \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Promoções de Fim de Semana",
    "playlistId": "abc123",
    "targetType": "all_screens",
    "dayOfWeek": [0, 6],
    "startTime": "09:00",
    "endTime": "21:00",
    "priority": 10,
    "color": "#3B82F6"
  }'

Atualizar Agendamento

PATCH /api/v1/schedules/:scheduleId

Todos os campos são opcionais. Usa as mesmas definições de campo de Criar Agendamento.

Excluir Agendamento

DELETE /api/v1/schedules/:scheduleId

Retorna 204 No Content em caso de sucesso.

---

Códigos de Status HTTP