Für die Nutzung der sklera API sind grundsätzlich drei Punkte notwendig:
- Der Channel für den die API genutzt werden soll hat das Lizenzmodell sklera Standard oder sklera Professional
- Ein sklera Benutzer der für den Zugriff auf den Channel berechtigt ist
- Die Generierung eines API Tokens für den Benutzer
API Token einsehen oder generieren
Die Möglichkeit den API Token einzusehen oder bei Bedarf zu erzeugen findet sich im sklera CMS unter Mehr->Benutzer bei der Bearbeitung eines Benutzers. Unter den Account-Daten befindet sich ein Punkt 'API Token', wo dieser angezeigt bzw. ggf. mittels Klick auf den entsprechenden Button erzeugt werden kann.
Hinweis: Bitte bewahren Sie diesen Token sicher auf und geben Sie ihn nicht weiter. Mithilfe dieses Token kann jeder in Besitz diesen berechtigte Channels im Rahmen der von der API zur Verfügung gestellten Möglichkeiten verändern. Im Zweifel können Sie jederzeit einen neuen Token generieren.
Requests
Requests an die sklera API sind allgemein HTTP requests - je nach Endpoint GET, POST, PUT oder DELETE. Zusätzlich muss der API Token mit jedem Request im Header mitgeschickt werden.
Die API erwartet einen JSON Body.
Die Dokumentation der API finden Sie auf my.sklera.tv