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
AUTORISIERUNG / AUTHENTIFIZIERUNG
Die REST-API unterstützt die Basic- und die Bearer Autorisierung. Ein Bearer Token kann über den Endpunkt /api/v1/Token der REST-API erstellt werden. Die Lebensdauer des Bearer Tokens kann in der Datei appsettings.production.json konfiguriert werden.
Für das Erzeugen des Tokens und auch für die Basic Autorisierung muss sich der Benutzer mit einem TimeSafe-Login und Passwort authentifizieren.
Der Benutzer verfügt bei der Verwendung der REST-API über dieselben Berechtigungen wie bei der Benutzung 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.
