DE / ENKontakt

WISSEN / DIGITAL SIGNAGE (DS MANAGER)

Digital Signage: REST-API

Jedes Anzeigegerät mit DS Player und jeder DS-Server stellt dieselbe HTTP-Schnittstelle bereit. Endpunkte, Header und ein PowerShell-Beispiel.

Von INZOSO Resilience · Stand · 2 Min. Lesezeit

Grundlagen

  • Basis-Adresse: http://<gerät>:8080
  • Format: JSON (UTF-8)
  • Schreibende Aufrufe benötigen den Kopplungsschlüssel im Header X-Api-Key: <6-stelliger Schlüssel>
  • Fehler: JSON {"error": "…"} mit HTTP-Status 400, 401, 404, 500 oder 507

Lesen (ohne Schlüssel, im lokalen Netz)

  • GET /api/status: Name, Version, Playlist-Version, freier Speicher, Laufzeit, aktuell angezeigter Eintrag, IP, Ausrichtung
  • GET /api/playlist: aktuelle Playlist
  • GET /api/media: Liste der gespeicherten Medien
  • GET /api/settings: Ausrichtung und Ruhezeiten
  • GET /player: der Player (HTML)
  • GET /media/<datei>: Mediendatei (unterstützt Range-Anfragen)

Schreiben (mit X-Api-Key)

  • PUT /api/playlist: neue Playlist {"items":[…]}
  • PUT /api/device: Gerätename {"name":"Empfang"}
  • POST /api/media?name=<datei>: Datei hochladen (Rohdaten im Body)
  • DELETE /api/media/<id>: Medium löschen
  • PUT /api/settings: {"rotation":0|90|180|270, "quiet":{"enabled":true,"days":[1,2,3,4,5],"from":"20:00","to":"07:00"}}
  • PUT /api/alert: Sofortmeldung {"text":"…","mode":"full"|"banner","bg":"#B91C1C","fg":"#FFFFFF","minutes":30}
  • DELETE /api/alert: Sofortmeldung beenden
  • POST /api/reload: Anzeige neu laden
  • GET /api/playlog: Wiedergabeprotokoll (CSV, Semikolon-getrennt)

Playlist-Eintrag (Auszug)

Ein Eintrag hat u. a. die Felder id, type (image, video, pdf, text oder dashboard), title, duration, enabled und mediaId (aus /api/media). Optional gibt es ein Feld schedule mit days, from, to, startDate und endDate. Wochentage: 0 = Sonntag bis 6 = Samstag. Ohne schedule läuft der Eintrag immer.

Beispiel für ein schedule-Feld: {"days":[1,2,3,4,5],"from":"11:00","to":"14:00","startDate":"2026-12-01","endDate":"2026-12-24"}

Beispiel (Windows PowerShell)

$h = @{ 'X-Api-Key' = '123456' }
Invoke-RestMethod http://192.168.1.50:8080/api/alert -Method Put -Headers $h -ContentType 'application/json' -Body '{"text":"Feueralarm-Probe 10 Uhr","minutes":15}'

Gerätesuche

UDP-Broadcast mit dem Text DS_DISCOVER an Port 8081. Jedes Gerät antwortet mit {"name":"…","port":8080}.

Sicherheit

Schreibzugriffe sind durch den Kopplungsschlüssel geschützt. Die Verbindung ist unverschlüsselt (HTTP). Betreiben Sie die Geräte nur in vertrauenswürdigen lokalen Netzwerken und geben Sie die Ports nicht ins Internet frei.

Digital Signage REST APISofortmeldung per SkriptDS Player APIPlaylist per APIDigital Signage Automatisierung

Häufige Fragen

Brauche ich für lesende Aufrufe einen Schlüssel?

Nein. Lesende Aufrufe sind im lokalen Netz offen. Schreibende Aufrufe brauchen den Kopplungsschlüssel im Header X-Api-Key.

Ist die API verschlüsselt?

Nein, sie nutzt unverschlüsseltes HTTP. Betreiben Sie sie nur in vertrauenswürdigen Netzwerken.

WEITERLESEN

Nächster Schritt

Sie haben eine konkrete Frage?

Schreiben Sie uns kurz Ihre Situation. Wir ordnen sie ein und sagen offen, ob und wie wir helfen können.

Gespräch anfragen