Datenimport/-export Schnittstelle
Weitere Optionen
Konfiguration
Um die REST API zu aktivieren, muss in der Konfigurationsdatei "appsettings.json" folgendes Property gesetzt sein:
"RestApi": { "Enabled": true}
Einstellungen
Wurde die REST API im "appsettings.json" aktiviert, finden Administratoren einen neuen Bereich in den Globalen Einstellungen über den die REST API jederzeit aktiviert und deaktiviert werden kann.
- REST Schnittstelle aktivieren:
- Diese Option aktiviert die Endpunkte der REST Schnittstelle. Ist diese Option deaktiviert, dann nimmt die REST Schnittstelle keine Request entgegen.
- SwaggerUI aktivieren
- Diese Option aktiviert die SwaggerUI, dabei handelt es sich um eine interaktive Beschreibung der REST Schnittstelle. Sie kann unter "/swagger" erreicht werden. Diese Seite ist nur für Entwickler relevant die mit der REST Schnittstelle kommunizieren möchten. Diese Option hat keine Auswirkung auf die Funktionalität der REST Schnittstelle. Wird sie deaktiviert, funktioniert die REST Schnittstelle, sofern sie aktiviert ist, trotzdem.
Swagger / OpenApi Dokumentation
Wie vorher beschrieben, findet man die Dokumentation der REST API unter "/swagger" wenn die SwaggerUI aktiviert ist.
Auf dieser Seite ist auch die JSON Beschreibung der REST API zu finden. Diese Beschreibung kann von Tools (z.b editor.swagger.io) verwendet werden um automatisch Clients für die REST API zu generieren.
ApiKeys
Alle Endpunkte der REST API sind über ApiKeys gesichert!
Damit Requests an die REST API erfolgreich durchgeführt werden können, muss in jedem Request ein gültiger ApiKey im "Authorization" Header mit gesendet werden.
ApiKeys können dabei nur von Administratoren erstellt werden. Jeder Administrator kann zu jedem Zeitpunkt nur einen gültigen ApiKey haben.
ApiKeys können mit einem Ablaufdatum erstellt werden. Ein Administrator kann aber seinen eigenen ApiKey jederzeit widerrufen, wodurch über den ApiKey anschließend keine Requests mehr durchgeführt werden können.
Um ApiKeys zu verwalten empfiehlt es sich pro Applikation, die die REST API ansteuert, einen Administrator anzulegen um einen ApiKey pro Applikation zu bekommen. Dadurch kann einer Applikation jederzeit der Zugriff genommen werden.