1
Interesse melden
Melden Sie sich bei Ihrem Key-Account-Manager, wenn Sie unsere Schnittstelle nutzen möchten. Gemeinsam starten wir Ihr Projekt!
2
Zugang zur Sandbox erhalten
Sie haben sich in die fachlichen und technischen Dokumente eingelesen und möchten loslegen? Unsere IT stellt Ihnen die nötigen Zugangsdaten für die Sandbox zur Verfügung, damit Sie Ihre Entwicklung beginnen können.
3
Schnittstelle in der Sandbox entwickeln
Nutzen Sie die Sandbox-Umgebung, um Ihre Schnittstelle vollständig und risikofrei zu entwickeln. Sie haben volle Kontrolle über die Implementierung.
4
Produktiv gehen & Daten importieren
Sobald Ihre Entwicklung abgeschlossen ist, erhalten Sie von unserer IT die Zugangsdaten für die Produktivumgebung. Der Datenimport kann starten – Ihre Schnittstelle ist einsatzbereit!
Woraus besteht eine API?
Eine API (Application Programming Interface) besteht aus verschiedenen Tools, Definitionen und Protokollen, die je nach Anwendungsgebiet variieren können. Dennoch beinhalten APIs stets die folgenden Komponenten:
- Technische Spezifikation: Diese beschreibt die Möglichkeiten des Datenaustauschs zwischen den Lösungen. Die Spezifikation erfolgt in Form von Anfragen für Verarbeitungs- und Datenlieferprotokolle.
- Softwareschnittstelle: Diese wird basierend auf der technischen Spezifikation entwickelt und stellt die Schnittstelle dar.
Um was für eine API handelt es sich?
Bei dieser API handelt es sich um eine REST-API.
Was ist eine REST-API?
Eine REST-API (Representational State Transfer API) ist eine Web-API, die den Prinzipien der REST-Architektur folgt und die Interaktion mit RESTful Webservices ermöglicht. REST, entwickelt vom US-amerikanischen Informatiker Roy Fielding, ist eine Sammlung von Architekturbeschränkungen.
Wenn eine Client-Anforderung über eine REST-API gestellt wird, überträgt diese eine Repräsentation des Ressourcenstatus an den Anforderer oder Endpunkt. Diese Repräsentation, sowie die damit verknüpften Informationen, werden in einem der folgenden HTTP-Formate bereitgestellt: JSON (JavaScript Object Notation), HTML, XML, Python, PHP oder Plain Text.
Welche Probleme löst die API und welche Bedürfnisse werden erfüllt?
-
Zentralisierte Schadendaten: Sie benötigen nur noch ein Surface, um alle Schadendaten einzusehen. Dies vereinfacht den Zugriff und die Verwaltung erheblich.
-
Effiziente Fahrzeugdatenverwaltung: Sie Fahrzeugdaten nur noch in ein System eingeben und keine Excel-Tabellen mehr senden. Dies reduziert den administrativen Aufwand und minimiert Fehlerquellen.
Welche Integrationsmöglichkeiten bietet die API?
Da es sich um eine REST API handelt, kann jede API-fähige Schnittstelle integriert werden. Nach erfolgreicher Verifizierung kann der Datenaustausch beginnen. Voraussetzung ist die Einhaltung der vorgegebenen Datenkonfiguration, um die Inhalte korrekt ins System zu importieren oder zu exportieren.
Wie funktioniert die technische Anbindung? Wie ist die Benutzeroberfläche gestaltet?
Die technische Anbindung wird im zu erstellenden API-Guide detailliert beschrieben. Es gibt keine dedizierte Benutzeroberfläche, da die API zur Verbindung von Systemen dient. Ziel ist es, dass sich Sie sich in ihren gewohnten (Fuhrparkmanagement-)Systemen bewegen und die Daten entweder dort eingeben (Fahrzeuge) oder empfangen und anzeigen lassen (Schadendaten, zugeordnet zum jeweiligen Fahrzeug).
Wie kann ich meine Systeme mit der API verbinden?
Die API arbeitet mit allen REST API-fähigen Schnittstellen zusammen. Das Datenformat muss für den Import und Export berücksichtigt werden, sodass die Daten korrekt eingelesen und im empfangenden System sauber dargestellt werden können. Gegebenenfalls sind Konfigurationen auf Seiten der anschließenden Systeme notwendig.
Welche Sicherheitsmaßnahmen sind implementiert?
Für die Authentifizierung verwenden wir das OpenID Connect Protokoll, das vom Keycloak-Server verwaltet wird. Jede Anwendung (Client) erhält individuelle Anmeldedaten. Der API-Dienst wird über das HTTPS-Protokoll bereitgestellt.
Wie wird der Datenschutz gewährleistet?
Der Datenschutz wird durch unser Berechtigungsmodell gewährleistet, das auf Mandanten- und Kundenunternehmensrechten basiert. Dieses Modell stellt sicher, dass nur autorisierte Benutzer Zugriff auf bestimmte Daten haben.
Wie wird die API gewartet und aktualisiert?
Unsere API wird als REST-API bereitgestellt und verwendet eine Versionsnummer in der URL. Bei jeder Änderung informieren wir unsere Kunden und erhöhen bei einer breaking change die Versionsnummer, um die Abwärtskompatibilität zu gewährleisten.
Wie finde ich weitere Informationen zu den Use Cases und der technischen Funktionsweise der Schnittstelle?
Weitere Informationen können Sie den beigefügten Dokumenten entnehmen:
