REST API - Übersicht

Die Screenzzie REST API ermöglicht es Ihnen, Ihre Digital Signage-Bildschirme, Playlists, Medien und Zeitpläne programmatisch zu verwalten. Perfekt für Integrationen, Automatisierung und benutzerdefinierte Anwendungen.

Basis-URL

Alle API-Endpunkte sind verfügbar unter:

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

Authentifizierung

Die API verwendet Bearer-Token-Authentifizierung mit API-Schlüsseln. Fügen Sie Ihren API-Schlüssel im Authorization-Header ein:

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

Einen API-Schlüssel erhalten

1. Gehen Sie zu Einstellungen > API-Schlüssel in Ihrem Screenzzie-Dashboard
2. Klicken Sie auf API-Schlüssel erstellen
3. Wählen Sie einen beschreibenden Namen und wählen Sie Berechtigungen
4. Kopieren Sie Ihren Schlüssel sofort (er wird nur einmal angezeigt!)

API-Schlüssel-Berechtigungen

Beim Erstellen eines API-Schlüssels können Sie aus drei Berechtigungsstufen wählen:

Rate Limits

API-Anfragen sind basierend auf Ihrem Abonnementplan begrenzt:

Rate-Limit-Header sind in allen Antworten enthalten:

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

Antwortformat

Alle Antworten werden im JSON-Format mit einer konsistenten Struktur zurückgegeben:

Erfolgreiche Antwort

{
  "success": true,
  "data": {
    // Ressourcendaten hier
  }
}

Paginierte Antwort

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

Fehlerantwort

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Name ist erforderlich",
    "details": { ... }
  }
}

Fehlercodes

Verfügbare Endpunkte

Die API bietet folgende Ressourcen:

• Bildschirme - Ihre Digital Signage-Bildschirme verwalten
• Playlists - Playlists erstellen und verwalten
• Medien - Auf Mediendateien zugreifen und registrieren
• Zeitpläne - Inhalte planen (Growth-Plan)

Nächste Schritte

• Sehen Sie die API-Endpunkte-Referenz
• Erstellen Sie Ihren ersten API-Schlüssel im Dashboard