sklera - digital signage made easy

Mithilfe der Nachrichten-API können Sie mit wenig Aufwand auch von außerhalb des sklera CMS dynamisch kurze Nachrichtentexte auf Ihre Bildschirme bringen. Ihnen stehen alle Möglichkeiten offen, welcher Ihnen der Menüpunkt Mehr -> Nachrichten im sklera CMS bietet.

Sie können diese Funktion auf Anfrage gerne auch als Demonutzer in Anspruch nehmen.

1. Registrieren Sie Ihren Demozugang (sofern Sie das nicht bereits getan haben)

Sie können sich schnell und kostenlos einfach mittels einer E-Mail-Adresse unter https://sklera.tv/de/demo-anfordern für einen Demozugang registrieren. Dieser ist 15 Tage aktiv, und kann einmalig und ebenso kostenfrei um 14 Tage verlängert werden!

Schon sklera Kunde? Die REST API steht allen unseren sklera Kunden ab der sklera standard Lizenz zur Verfügung.

2. Kontaktieren Sie uns zwecks Aktivierung der REST-API

Das REST-API-Feature ist standardmäßig bei einem Demozugang deaktiviert und erfordert einen kleinen Eingriff unsererseits. Kontaktieren Sie uns einfach über die 'Demozugang verlängern'-Funktion in der Infoleiste des sklera CMS und fügen Sie noch den Hinweis ein, dass Sie gerne die REST-API testen wollen.

Alternativ schicken Sie uns einfach eine formlose E-Mail an support@sklera.tv mit der entsprechenden Info sowie der E-Mail-Adresse mittels derer Sie sich für die sklera Demo registriert haben.

Wir führen dann die entsprechenden Anpassungen durch und melden uns mit der Channel ID bei Ihnen.

3. Erzeugen Sie einen API Token für Ihren Benutzer

Loggen Sie sich in das sklera CMS ein. Im Benutzermenü oben rechts finden Sie den Punkt 'Benutzereinstellungen'. Rufen Sie diesen auf - dort finden Sie die Möglichkeit einen API Token zu erzeugen. Kopieren Sie diesen, und speichern Sie die Änderungen an Ihrem Benutzerprofil.

Hinweis: Bewahren Sie diesen API Token sicher auf. Dieser ermöglicht es im Rahmen Ihrer Benutzerberechtigungen Zugriff auf verschiedene Funktionen des sklera CMS ohne sich einloggen zu müssen. Teilen Sie diesen Token nicht. Falls Sie den Verdacht haben, dass der Token Unbefugten bekannt ist können Sie in den Benutzereinstellungen jederzeit einen neuen erzeugen.

4. Setzen Sie einen Request ab

Um eine neue Nachricht zu erzeugen, senden Sie einen HTTP-POST-Request an /data/api/messages/new an sklera - mit dem apiToken im Header. Die vollständige URL ist  https://my.sklera.tv/data/api/messages/new

Die API erwartet einen JSON-Body, der im einfachsten Fall (Nachricht an alle angeschlossenen aktiven Displays mit einer Anzeigedauer) so aussieht:

{
    "channelId" : "channel ID aus Punkt 2",
    "allScreens": true,
    "text": "Ihre Nachricht",
    "hasDuration": true,
    "duration": 0,
    "enable": true
}

Die duration - die Anzeigedauer am Display - ist in Sekunden anzugeben.

Die API-Dokumentation finden Sie unter https://my.sklera.tv/data/api/swagger/

Beachten Sie, dass Strings (=Texte/Zeichenketten) zwischen doppelten Hochkommas " liegen müssen.

Wie genau Sie diesen Request absetzen steht Ihnen gänzlich frei.

Testen der Nachrichtenanzeige

Um die Anzeige von Nachrichten zu testen benötigen Sie aktive, mit sklera verbundene sklera Player. Sie können für die Tests einen virtuellen Player verwenden. Um einen solchen virtuellen Player zu öffnen, rufen Sie in einem neuen Browserfenster die Adresse https://start.sklera.tv auf und verwenden Sie den angezeigten Pairing Code um das virtuelle Display mit sklera zu verknüpfen. Bitte beachten Sie, dass das Hinzufügen  eine freie sklera Lizenz im Channel benötigt.

Lesen Sie hier wie Sie Displays zu sklera hinzufügen können.

Ich nutze mehrere sklera Displays. Wie kann ich mittels der Nachrichten API einen oder mehrere bestimmte Bildschirme ansprechen?

Sie können anstatt aller im Channel verbundenen Screens auch nur spezifische Displays ansprechen.

Dazu ersetzen Sie im JSON Body den Wert "allScreens" durch "screens", und legen dort die Screens mittels eines Array von Screen IDs fest:

{
    "channelId" : "channel ID aus Punkt 2",
    "screens": [ "screenid1", "screenid2", .... "screenIdN"  ],
    "text": "Ihre Nachricht",
    "hasDuration": true,
    "duration": 0,
    "enable": true
}