Panoramica REST API

La REST API di Screenzzie Le permette di gestire programmaticamente i Suoi schermi di digital signage, playlist, media e programmazioni. Perfetta per integrazioni, automazione e applicazioni personalizzate.

URL Base

Tutti gli endpoint API sono disponibili su:

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

Autenticazione

L'API utilizza l'autenticazione Bearer token con API key. Includa la Sua API key nell'header Authorization:

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

Ottenere una API Key

1. Vada su Impostazioni > API Keys nella Sua dashboard Screenzzie
2. Clicchi Crea API Key
3. Scelga un nome descrittivo e selezioni i permessi
4. Copi la Sua key immediatamente (viene mostrata solo una volta!)

Scope delle API Key

Quando crea una API key, puo scegliere tra tre livelli di permesso:

Limiti di Frequenza

Le richieste API hanno limiti di frequenza in base al Suo piano di abbonamento:

Gli header dei limiti di frequenza sono inclusi in tutte le risposte:

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

Formato delle Risposte

Tutte le risposte sono restituite in formato JSON con una struttura coerente:

Risposta di Successo

{
  "success": true,
  "data": {
    // Dati della risorsa qui
  }
}

Risposta Paginata

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

Risposta di Errore

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Name is required",
    "details": { ... }
  }
}

Codici di Errore

Endpoint Disponibili

L'API fornisce le seguenti risorse:

• Schermi - Gestisca i Suoi schermi di digital signage
• Playlist - Crei e gestisca playlist
• Media - Acceda e registri file media
• Programmazioni - Programmi contenuti (piano Growth)

Prossimi Passi

• Veda il riferimento degli Endpoint API
• Crei la Sua prima API Key nella dashboard