Przeglad REST API

REST API Screenzzie pozwala programowo zarzadzac ekranami digital signage, playlistami, mediami i harmonogramami. Idealne dla integracji, automatyzacji i niestandardowych aplikacji.

Bazowy URL

Wszystkie endpointy API sa dostepne pod adresem:

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

Autentykacja

API uzywa uwierzytelniania Bearer token z kluczami API. Dolacz swój klucz API w naglowku Authorization:

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

Uzyskiwanie klucza API

1. Przejdz do Ustawienia > Klucze API w panelu Screenzzie
2. Kliknij Utworz klucz API
3. Wybierz opisowa nazwe i uprawnienia
4. Skopiuj klucz natychmiast (pokazywany jest tylko raz!)

Zakresy kluczy API

Podczas tworzenia klucza API mozesz wybrac z trzech poziomow uprawnien:

Limity zapytan

Zapytania API sa limitowane na podstawie planu subskrypcji:

Naglowki limitow sa dolaczane do wszystkich odpowiedzi:

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

Format odpowiedzi

Wszystkie odpowiedzi sa zwracane w formacie JSON ze spojna struktura:

Odpowiedz sukcesu

{
  "success": true,
  "data": {
    // Dane zasobu tutaj
  }
}

Odpowiedz ze stronicowaniem

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

Odpowiedz bledu

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Nazwa jest wymagana",
    "details": { ... }
  }
}

Kody bledow

Dostepne endpointy

API udostepnia nastepujace zasoby:

• Ekrany - Zarzadzaj ekranami digital signage
• Playlisty - Twórz i zarzadzaj playlistami
• Media - Dostep do biblioteki mediow i rejestracja plikow
• Harmonogramy - Planuj tresci (plan Growth)

Nastepne kroki

• Przegladaj referencje Endpointow API
• Utworz swój pierwszy Klucz API w panelu