EINLEITUNG
Die Leistungserfassung besitzt eine REST/JSON Schnittstelle, welche es anderen Programmen ermöglicht mit ihr zu kommunizieren.
DOKUMENTATION
Die verschiedenen Aufrufe, mit den jeweiligen Parametern und Antworten der aktuellen REST-API, können Sie unter der folgenden URL finden:
https://test.timesafe.ch/tsl-restapi/swagger/index.html
Auf ihrem System können Sie die Dokumentation nach der Inbetriebnahme abhängig von der Installation im IIS unter folgender URL finden:http://IHRETimeSafeLeistungserfassungREST-API-URL/swagger
AUTHENTIFIZIERUNG und AUTORISIERUNG
Die REST-API unterstützt die Basic- und die Bearer Authentifizierung. Ein JWT-Token (Bearer) kann über den Endpunkt /api/v1/Token der REST-API erzeugt werden. Die Lebensdauer des JWT-Tokens kann in der Datei appsettings.production.json konfiguriert werden.
Für das Erzeugen des Tokens und auch für die Basic Authentifizierung muss sich der Benutzer mit einem TimeSafe-Login und Passwort anmelden.
Der Benutzer wird bei der Verwendung der REST-API mit denselben Berechtigungen autorisiert wie bei der Nutzung des Desktop- oder Webclients der TimeSafe Leistungserfassung.
INBETRIEBNAHME
Die notwendigen Schritte für die Inbetriebnahme der Schnittstelle sind in der Installationsanleitung im Kapitel „REST-API“ beschrieben.
