Beschreibung

Aufgrund der offenen Endpunkt-Programmierung kann hse-COACH an mehreren Stellen Daten austauschen. Je nach Installationsform (Cloud/on-premise) und Kundenvorgabe erfolgt die initiale Parameterübergabe per URL-Query oder Datei-Polling-Prozess.

URL-Query

Initiale URL-Aufrufe werden gemäß Kundenwunsch ausgeführt und enthalten in der Regel nur eine (temporäre) Unique-ID (UID). Diese UID kann gegebenenfalls noch durch vereinbarte Prüfverfahren (z. B. Modulo, Security Key, etc.) im hse-COACH verifiziert werden. Der initiale URL-Aufruf wird durch die führende Software erzeugt und z. B. per E-Mail an die Probanden verschickt. Alternativ besteht auch die Möglichkeit eines direkten Aufrufs an einem spezifischen Endgerät.

Datei-Polling-Prozess

Dateibasierte Initialisierungen erfolgen über einen Polling-Prozess, der zunächst die vereinbarte Nomenklatur überprüft, ggf. daraus Parameter extrahiert und den CSV-Inhalt liest. Je nach Kundenwunsch werden neben der UID (Badge-ID, Personalnummer, PID, o. ä.) hier bereits alle relevanten Personendaten zur Identitätsverifizierung/-abfrage übermittelt.

Uni-/Bidirektional

Mit Ausnahme des SOAP-Webservice wurden alle Schnittstellen bisher sowohl uni- oder bidirektional realisiert. In der bidirektionale Auslegung wurden diverse Sicherheitsmechanismen realisiert, beispielsweise von User-/Passwortkombinationen, Secret keys oder Prüfalgorithmen. Übermittelt wird durch den Server initial minimal der vordefinierte Lernkurs und ggf. eine “echte” UID. Häufig werden aber auch die relevanten Personendaten zur aktiven Identitätsbestätigung vor Trainingsstart übermittelt.

Protokolle

Grundsätzlich sind Schnittstellen auch mit gemischten Protokollen möglich, d. h. zum Beispiel am Ende des Prozesses die erzeugten Testdaten per HTTP- im JSON-Format und ein Filetransfer eines kundenspezifisch erstellten Dokuments.

Sofern möglich, sollte die Erzeugung von Dokumenten aus Datenschutzgründen jedoch nicht clientseitig erfolgen, sondern beispielsweise direkt im FTP-S-Ordner.

Fazit:

Bisher konnten wir alle kundenspezifischen Anforderungen an eine Schnittstelle abbilden und diese dank der offenen Architektur des hse-COACH teilweise kostenfrei innerhalb weniger Stunden umsetzen.


Tabelle realisierter Schnittstellen

Die nachfolgende Aufstellung gibt einen groben Überblick, welche Schnittstellen-Typen bisher realisiert wurden. Kundennamen und Software-Produkt werden aus Datenschutzgründen nicht genannt.

Name Protokoll Typ Code Initiale Parameter Rückgabe Server Rückgabe Client Testende
Webservice SOAP HTTPS/SOAP bidirektional PHP SOAP Procedure Call > maschinell gelesene Ausweis-ID Format XML: unknown oder Personendaten zur Identitätsbestätigung, Kurs-ID SOAP Procedure XML: Erfolg, Badge-ID, Kurs-ID, Test-Datum, Test-Gültigkeit in Tagen
S-FTP PNG-Datei
Webservice REST HTTPS unidirektional PHP URL-Query mit manueller/maschineller Ausweis-ID success am Prozedurende HTTPS/POST: Erfolg, Badge-ID, Test-Datum, Test-Gültigkeit in Tagen
Webservice REST HTTPS bidirektional PHP URL-Query mit manueller/interne ID Format JSON: unknown oder Personendaten zur Identitätsbestätigung, Kurs-ID JSON: Erfolg, interne ID
Webservice REST / SWAGGER HTTPS bidirektional PHP URL-Query mit Personalnummer Format JSON: unknown oder Personendaten zur Identitätsbestätigung, Kurs-ID HTTPS POST: Kurs-ID, PID Erfolg
Filetransfer FTP-S/SFTP unidirektional PHP Manuell erfasste Sozialversicherungsnummer CSV / PNG:
CSV-Datei gemäß Nomenklatur; PNG-Datei gemäß Nomenklatur
Filetransfer FTP-S/SFTP bidirektional PHP Polling Format CSV: UID, Personendaten zur Identitätsbestätigung, Kurs-ID CSV: UID, Testdatum/-zeit
E-Mail TCP/POP3 unidirektional PHP Manueller Input Format CSV: Generierte UID, Personendaten, Kurs-ID

20230620_hse-COACH_Schnittstellen.pdf