API-Anbindung
timatra kann über eine Programmierschnittstelle (API) mit anderen Prozessen und Softwarelösungen verbunden werden. Dadurch können berechtigte Systeme Daten automatisiert austauschen, ohne dass diese von Hand übertragen werden müssen.
Technische Rahmenbedingungen
Die verfügbaren Schnittstellen werden mit einer OpenAPI-3-Spezifikation beschrieben. Diese maschinenlesbare Beschreibung zeigt der betreuenden IT, welche Funktionen und Daten verfügbar sind und wie sie angesprochen werden.
Die Anmeldung und Absicherung der Verbindung erfolgt über die etablierten Standards OpenID Connect (OIDC) und OAuth 2.0. Für die direkte Kommunikation zwischen zwei Systemen wird ein eigener Service-to-Service-Client mit einem OAuth Client Credentials Flow verwendet. Das ist in der Regel für die Anbindung der Admin-API nötig. Bei der Anbindung eines neuen Mitarbeiter-Clients kann die Anmeldung über den Authorization Code Flow erfolgen.
API-Zugang beantragen
- Fragen Sie bei uns einen Service-to-Service-Client und den Zugang zur OpenAPI-3-Spezifikation an.
- Stimmen Sie mit uns ab, welche Daten und Funktionen die anzubindende Software benötigt.
- Ihre IT oder Ihr betreuender Softwaredienstleister richtet die Verbindung anhand der bereitgestellten Spezifikation und Zugangsdaten ein.
Falls eine benötigte API-Route noch nicht vorhanden ist, kann diese ebenfalls bei uns angefragt werden. Wir prüfen anschließend, ob und wie die gewünschte Funktion über die API bereitgestellt werden kann.
Zugangsdaten schützen
Die Zugangsdaten des Service-to-Service-Clients sind ausschließlich für das angebundene System bestimmt und müssen von der betreuenden IT sicher verwahrt werden.