Zum Inhalt springen

Software-Schnittstellen planen: welche Fragen vorab geklärt sein sollten

Für eine Software-Schnittstelle müssen Auslöser, Datenrichtung und Zuständigkeit feststehen. Klären Sie ausserdem, welches System den gültigen Stand enthält und was bei Fehlern passiert. «Shop ans ERP anbinden» ist dafür noch keine ausreichend konkrete Anforderung.

Illustration: Systeme sinnvoll verbinden

Ein Ratgeber von Codexo GmbH.

Den gewünschten Datenfluss beschreiben

Eine Schnittstelle verbindet Anwendungen und überträgt Daten zwischen ihnen. Eine API ist ein dafür vorgesehener technischer Zugang. Beschreiben Sie zuerst den Ablauf: «Eine bezahlte Bestellung erzeugt im ERP, unserem System für die Auftragsbearbeitung, einen Auftrag mit Kunde, Artikeln und Versandart.» Soll auch der Lagerbestand zurück in den Shop fliessen?

Klären Sie, welche Zugriffsmöglichkeiten, Daten und Nutzungsrechte die Systeme tatsächlich bieten. Eine API kann vom Tarif abhängen oder Nutzungslimits haben. Für eine individuelle Systemanbindung braucht es deshalb Dokumentation und möglichst einen Testzugang.

Eine führende Quelle festlegen

Wenn beide Systeme denselben Wert ändern dürfen, entstehen Konflikte. Bestimmen Sie für Preise, Adressen und Status jeweils den verbindlichen Pflegeort. Ein verspäteter Datenlauf darf eine bewusste Korrektur nicht unbemerkt überschreiben.

  • Welches Ereignis startet die Übertragung?
  • Welche Felder werden in welche Richtung übertragen?
  • Welche Kennung verbindet die Datensätze?
  • Wie aktuell müssen die Daten am Ziel sein?
  • Wer entscheidet bei fachlichen Widersprüchen?

Fehler und doppelte Versuche berücksichtigen

Ein Dienst kann ausfallen, ein Zugang ablaufen oder ein Pflichtfeld fehlen. Für vorübergehende Störungen kann ein erneuter Versuch helfen; ein ungültiger Datensatz braucht eine Korrektur und eine verständliche Meldung.

Beispiel: Ein Auftrag wurde angelegt, die Bestätigung erreicht das sendende System aber nicht. Ein erneuter Versuch darf keinen zweiten Auftrag erzeugen. Vereinbaren Sie, wie Vorgänge wiedererkannt und ihre Zustände kontrolliert werden. Testen Sie auch verspätete Übertragungen.

Den Betrieb verbindlich zuordnen

Legen Sie fest, wer ausgebliebene Übertragungen bemerkt und Änderungen externer Dienste bearbeitet. Zugangsdaten gehören in eine geeignete Verwaltung mit begrenzten Berechtigungen.

Eine Anbindung ist nicht automatisch wartungsfrei. Die Betreuung Ihrer Anwendungen und Verbindungen sollte ausdrücklich benennen, welche Prüfungen und Reaktionen enthalten sind.

Passende Ratgeber

Alle Ratgeber für Schweizer KMU

Welche Daten möchten Sie zwischen welchen Anwendungen übertragen? Beschreiben Sie uns die Systeme und einen typischen Vorgang. Im Gespräch gehen wir Zugriffsmöglichkeiten, Datenregeln und die Bearbeitung von Fehlerfällen durch.

Welche Daten sollen Ihre Programme austauschen?

Systeme verbinden?