X-ERP Hilfe

04. Endpunkte, Datenverträge und Antworten

Behandeln Sie URL, Methode, Felder, Pflichtwerte, Statuscodes und Version als verbindlichen Vertrag zwischen X-ERP und dem angebundenen System.

Eine Schnittstelle wird stabil, wenn beide Seiten nicht nur Bytes, sondern dieselbe Bedeutung austauschen.

Die Schnittstelle als Produkt

Typische Muster sind seitenweise Listen, gezieltes Finden, Anlegen und Aktualisieren. Dazu gehören Datentyp, Nullwertbedeutung, Zeichenlänge, Zeit-/Währungsbezug, Pflichtfelder, Statuscodes und eine Strategie für kompatible Änderungen.

So wird die Anbindung robust

  1. Dokumentieren Sie je Use Case Controller, Methode, Route, Request, Response und erlaubte Statuscodes.
  2. Definieren Sie Feldbedeutung, Einheit, Zeitzone, Null-/Leerwert und maximale Länge.
  3. Erstellen Sie Beispielverträge für Normal-, Grenz- und Fehlerfall.
  4. Validieren Sie vor dem Senden und nach dem Empfangen.
  5. Versionieren Sie Mapping und Vertrag gemeinsam mit dem Client.

Produktionsreife nachweisen

  • Jedes Feld besitzt fachliche Bedeutung und Eigentümer.
  • Unbekannte Response-Felder brechen den Client nicht.
  • Fehlende Pflichtwerte werden vor dem Aufruf erkannt.
  • Statuscodes führen zu definierter Verarbeitung.

Fehler, die erst im Betrieb teuer werden

  • Ein HTTP 200 wird mit fachlichem Erfolg gleichgesetzt, ohne Inhalt zu prüfen.
  • Datum ohne Zeitzone verschiebt Geschäftstage.
  • Client bindet starr an eine zufällige Beispielantwort.

Das nehmen Sie mit

Der Datenfluss bleibt auch dann verständlich, wenn Versionen, Felder und Fehlerzustände sich weiterentwickeln.

Weiterführender Link / Quelle

Weiterführende Themen

  1. Für Integrationsspezialisten – APIs und externe Systeme anbinden › 05. Filtern, paginieren und große Datenmengen
  2. Für Integrationsspezialisten – APIs und externe Systeme anbinden › 06. Artikel und Partner synchronisieren
  3. Für Integrationsspezialisten – APIs und externe Systeme anbinden › 08. Schreiben, Idempotenz und Parallelität

Häufige Fragen

**Was gehört in einen Datenvertrag?**

Route/Methode, Authentifizierung, Felder, Typen, Pflicht-/Nullregeln, Einheiten, Beispiele, Statuscodes, Version und Verantwortliche.

**Wie gehe ich mit neuen Response-Feldern um?**

Robust ignorieren, protokolliert beobachten und erst nach fachlicher Freigabe verwenden.