LiveConfig 3 - REST API
Kategorie:
LiveConfig
Erstellt: 28.06.2022
Aktualisiert: 28.04.2026
Ab Version 3.0 stellt LiveConfig eine moderne REST-API bereit. Es ist auch möglich, Endkunden einen API-Zugriff zu erlauben (über die entsprechende Berechtigung in den Accounts bzw. Vorlagen).
Die Authentifizierung erfolgt über ein sogenanntes Bearer Token, welches als HTTP-Header (Authorization: Bearer ...) mit jeder Anfrage mitgesendet werden muss. Die Token können in den Benutzereinstellungen erzeugt und verwaltet werden. Dort kann auch die API-Dokumentation eingesehen werden - gefiltert auf die Funktionen, für welche der jeweilge Benutzer tatsächlich berechtigt ist.
Um im Kontext von Kunden/Endnutzern auf Objekte zuzugreifen (z.B. um Webspace-Einstellungen einer Domain zu bearbeiten), kann über einen entsprechenden HTTP-Header eingestellt werden, als welcher Kunde oder Benutzer ein Zugriff ausgeführt werden soll:
X-Customer-ID: hier kann man die Kundennummer eines eigenen (direkten) Kunden angeben; der Request wird dann im Kontext von dessen Hauptbenutzer ausgeführt.X-User-Name: hier kann man den LiveConfig-Benutzernamen eines beliebig tief verschachtelten Nutzers angeben, mit dem der Zugriff ausgeführt werden soll.
Bitte beachten Sie zudem:
- bei fast allen Requests muss im Anfrage-Header
Accept: application/jsonmitgesendet werden - bei fast allen übermittelten Daten (
PATCH,POST) müssen die Daten im JSON-Format und mit dem HeaderContent-Type: application/jsonübermittelt werden
Die Schnittstellen-Dokumentation steht im OpenAPI-Format zu Verfügung (Source: lc3-api.json). In der nachfolgenden Liste finden Sie alle derzeit verfügbaren Funktionen, Lese-Zugriffe können Sie damit auch direkt testen (diese werden an den LiveConfig Demo-Server gesendet).