Foto zum Beitrag Schnittstellen prüfen: Formate, Richtung und Testszenario festhalten
Foto von StartupStockPhotos auf Pixabay

Prozesswerkzeuge

Teil von Prozesswerkzeuge vergleichen: Funktionen, Kosten und Einführungsaufwand

Schnittstellen prüfen: Formate, Richtung und Testszenario festhalten

Schnittstellen prüfen: Prüfpunkte für Datenformate, Richtung, Frequenz und Testszenarien sowie Dokumentation in einer Schnittstellenkarte, mit REST- und SOAP-Bezug.

Dies ist ein redaktionelles Pseudonym der Publikation und keine Behauptung einer unabhängig verifizierten persönlichen Identität. Ursprüngliche redaktionelle Zuordnung: Ressort Automatisierung.

Das Wichtigste auf einen Blick

  • Legen Sie je angebundenem System eine eigene Schnittstellenkarte an.
  • Erfassen Sie Quelle, Ziel, Art, Richtung, Datengruppe, Format und Testdatum.
  • Fragen Sie Formate und Versionen schriftlich beim Anbieter ab.
  • Testen Sie mit fester Datensatzmenge und vergleichen Sie eine Prüfsumme.
  • Dokumentieren Sie Ergebnis, Datum und offene Punkte nachvollziehbar.

Was eine Schnittstellenkarte leisten soll

Eine Schnittstellenkarte beantwortet eine Frage: Was fließt zwischen welchen Systemen, in welche Richtung, in welchem Format und mit welchem Prüfnachweis? Ohne diese Angaben bleibt jede Anbieteraussage eine Momentaufnahme. Sie können dann nicht sauber entscheiden, ob die Anbindung zu Ihrem Ablauf passt.

Die Karte ist kein technisches Handbuch, sondern ein Entscheidungsbeleg. Wer sie führt, kann Angebote vergleichen und offene Punkte gezielt nachfragen. Nach den BSI-Standards gehört zu einem belastbaren Nachweis, dass Prozesse, Schnittstellen und Freigaben methodisch beschrieben und geprüft werden (BSI IT-Grundschutz).

Felder, die jede Karte braucht

Halten Sie je System mindestens fest:

Pflichtfelder der Schnittstellenkarte

  • Quellsystem und Zielsystem mit Anbieter
  • Zweck der Übergabe in einem Satz
  • ArtImport, Export, API, Dateiübergabe
  • Richtunglesend, schreibend oder beides
  • Datengruppe, etwa Belege oder offene Posten
  • ErgänzenFormat, Taktung, Testdatum, Ansprechpartner

Ergänzen Sie Format, Taktung, Testdatum, Testumfang und den verantwortlichen Ansprechpartner. Lassen Sie ein Feld lieber leer als geraten. Ein offenes Feld ist eine Aufgabe, ein falscher Eintrag ist ein Risiko.

API-Standards: REST und SOAP einordnen

REST und SOAP beschreiben zwei verbreitete Wege für Schnittstellen. REST nutzt die Methoden von HTTP, etwa GET, POST, PUT und DELETE, und überträgt meist JSON. SOAP arbeitet mit XML, einer festen Nachrichtenhülle und einer Beschreibung in WSDL. Prüfen Sie, welchen Standard der Anbieter nennt und ob die Dokumentation zur tatsächlich angebotenen Version passt.

Normen und Standards sollen diese Angaben vergleichbar machen. Das Deutsche Institut für Normung erklärt, wie Normen und Standards technische Festlegungen beschreiben (DIN zu Normen und Standards). Verlassen Sie sich trotzdem nicht auf die Produktbezeichnung, sondern prüfen Sie Feldnamen, Pflichtfelder und Fehlerverhalten am eigenen Datenbestand.

Beispielkarte, klar als Beispiel gekennzeichnet

Die folgende Karte ist ein ausgefülltes Beispiel, keine Anbieterzusage. Format und Feldbelegung sind beim Anbieter zu bestätigen.

Beispielkarte

FeldBeispielinhalt
QuellsystemERP-System A
ZielsystemDMS B
ZweckÜbergabe der offenen Posten
ArtAPI-Import
Richtungnur von A nach B
Datengruppeoffene Posten
FormatJSON, laut Anbieter zu bestätigen
Taktungstündlich, laut Anbieter zu bestätigen
Testdatum15.05.2025, angenommenes Beispiel
Offener PunktFeldbehandlung bei Umlauten klären

Übertragen Sie im Test 20 Belegdatensätze und vergleichen Sie die Summe der offenen Posten. Weicht das Zielsystem ab, brechen Sie ab und dokumentieren Sie die Abweichung. Alle Werte stammen aus einem angenommenen Ablauf, nicht aus einer Messung.

Testszenario und Protokoll festhalten

Beschreiben Sie den Testlauf so, dass ihn eine andere Person wiederholen kann. Gehen Sie in drei Schritten vor:

Testszenario und Protokoll

  1. Testdaten festlegenMenge, Zeitraum und Pflichtfelder benennen.
  2. Erwartungswert notierenSumme, Anzahl und Prüfsumme vor der Übergabe bilden.
  3. Ergebnis protokollierenDatum, Beteiligte, Abweichung und offene Punkte festhalten.

Ein brauchbares Abbruchkriterium lautet: Summe im Zielsystem weicht nicht von der Summe im Quellsystem ab. Planen Sie eine Wiederholung mit erhöhter Datensatzmenge ein, bevor Sie zusagen. Ein Testlauf ohne schriftliches Ergebnis zählt für die Entscheidung nicht.

Sicherheit und Nachweis in die Karte aufnehmen

Schnittstellen sind auch Angriffsfläche. Erfassen Sie, wer lesen und wer schreiben darf, und ob eine Übertragung verschlüsselt ist. Für Prozessautomatisierung nennt das Bundesministerium für Wirtschaft und Klimaschutz Rahmenbedingungen und Förderwege (BMWK zu Prozessautomatisierung). Notieren Sie, ob Fördermittel oder Beratungsangebote für Ihre Einführung infrage kommen.

Häufige Fragen

Reicht die Anbieterangabe "bidirektional" für meine Planung?

Nein. Sie belegt die Richtung nur auf Produktebene. Prüfen Sie je Datengruppe getrennt, wer schreiben darf.

Was mache ich, wenn das Format nicht dokumentiert ist?

Feld leer lassen, schriftlich beim Anbieter nachfragen und das Ergebnis mit Datum in die Karte eintragen.

Wann ist eine Anbindung ausreichend geprüft?

Wenn ein protokollierter Testlauf mit definierter Datensatzmenge und Prüfsumme ohne Abweichung abgeschlossen ist.

Muss ich SOAP und REST gleichzeitig beherrschen?

Nein. Prüfen Sie, welchen Standard das Zielsystem fachlich und technisch verlangt, und dokumentieren Sie diese Festlegung.

Mehr aus Prozesswerkzeuge