Seitenhierarchie
Zum Ende der Metadaten springen
Zum Anfang der Metadaten

Inhalt:

Einführung

Grundlegendes

Die Schnittstelle konnektiert das Logistiksystem mit dem ERP System. Ziel ist der vollautomatische Datenaustausch zwischen beiden Systemen. Die Schnittstelle ist für weitere Anwendungsfälle erweiterbar zu gestalten. Der Datenaustausch finded asynchron statt und eine blockierung lokaler Prozesse bei Ausfall der Gegenseite ist nicht gegeben. Allerdings werden bestimmte lokale Prozesse durch die Einlieferung von Daten der Gegenseite ausgelöst.

Technische Realisierung

Die Schnittstelle ist als RESTful Webservice realisiert. Die Daten werden im JSON Format ausgetauscht. Hierfür werden von beiden Seiten entsprechende Dienstendpunkte bereitgestellt. 

Verantwortlichkeiten

Der Datenbereitsteller ist dafür verantwortlich seine Daten an das Fremdsystem über die Vereinbarte API zu übergeben. Das Fremdsystem stellt hierfür einen Dienstendpunkt bereit. Jeder Datenbereitsteller überwacht seinen Dienstendpunkt eigenverantwortlich auf Funktion und Verfügbarkeit.

Vorfallmanagement

Störfallverhalten auf Anwendungsebene (Dienstendpunkt)

Störfälle auf Dienstebene stellen in der Regel Ausfälle durch ein Softwarefehlverhalten dar (Server Error). Ebenfalls kann ein Ausfall die Nichterreichbarkeit des Dienstendpunktes selbst betreffen (Timeout). Dies kann geplant, durch Wartungsarbeiten, oder auch ungeplant durch Störungen eintreten.

Falls die Daten nicht erfolgreich übermittelt werden können, wird der Datenbereitsteller diese nach einer definierten Fehlerwartezeit erneut versuchen diese zu übermitteln. Dies wird solange wiederholt, bis die Daten erfolgreich übertragen werden konnten.

Störfallverhalten auf API-Ebene

Wird bei dem Aufruf der API ein Fehler zurückgegeben, betrachtet der Konsument (einliefender Client) dieses API Aufrufs dieses als fehlgeschlagen. Es wird nach einer definierten Fehlerwartezeit erneut versuchen die Funktion zu konsumieren. 

Die nicht erfolgreich übermittelten Daten werden dabei erneut als erstes übertragen. Der Konsument hält dafür alle anstehenden Übermittlungen in einer Warteschlange vor (FiFo Queue).

Verfügbarkeit

Die Regelverfügbarkeit des Dienstes für den Datenaustausch seitens Reinsch entspricht der Verfügbarkeitsklasse 3 (99,9 %). Wir können ihnen optional eine höhere Verfügbarkeit, entsprechend ihrer Anforderungen, bis zur Verfügbarkeitsklasse 5 (99,999 %) gewährleisten.

Prozessbeschreibung

Die Prozesse sind im Dokument Prozessbeschreibung definiert.

Dienstendpunkte

Allgemein

Der Dienstendpunkt ist über einen definierten Hostnamen erreichbar. Dieser Hostname sollte auf eine IPv4 und optional auf eine IPv6 Adresse auflösen.

Sicherheit

Die Transportsicherung erfolgt durch TLS Verschlüsselung (https). Hierfür ist ein gültiges Zertifikat zu verwenden. Falls erforderlich kann die ausstellende Zertifizierungsstelle in den Trusted Store der Laufzeitumgebung aufgenommen werden. Sofern diese nicht bereits bekannt ist.

Eine Inhaltsverschlüsselung erfolgt nicht. Optional ist es möglich den Zugriff auf die Dienstendpunkte auf bestimmte IPv4 und IPv6 Adressen einzuschränken. Der Zugriff wird durch Authentisierung, Authentifizierung sowie Autorisierung gesichert.

Authentifizierung

Für jeden Aufruf einer API Funktion wird der Request mit einem HTTP Basic Authentication Header versehen. Hierfür werden Benutzername und Passwort festegelt, mit denen sich der Client gegenüber dem Dienst authentifiziert. Ein Rollenbasiertes Modell ist nicht vorgesehen.

Versionierung

EIne Versionierung (/v1) des Dienstendpunktes ist nicht vorgesehen.


API

Der Aufbau der API ist in den Dokumenten unter API definiert.

Warenausgang

Wareneingang

Lagerbestand


  • Keine Stichwörter