Schnittstellen dokumentieren

Eine Schnittstelle (oder „Verbindung") beschreibt, dass zwei Systeme miteinander Daten austauschen – zum Beispiel, dass dein ERP nächtlich Rechnungsdaten an die Buchhaltung schickt oder dass ein Shop Bestellungen an die Lagerverwaltung übergibt.

Schnittstellen sind das Bindegewebe deiner IT-Landschaft. Erst sie machen aus einer Liste einzelner Apps ein zusammenhängendes Bild – und sie sind die Verbindungslinien, die du auf der Karte siehst.

Warum Schnittstellen dokumentieren?

Die eine Frage, die den Aufwand rechtfertigt: Was passiert, wenn dieses System ausfällt oder ausgetauscht wird – welche anderen Systeme sind betroffen?

Darüber hinaus zeigen dokumentierte Schnittstellen:

• Datenflüsse für NIS2 & DSGVO: Welche Daten verlassen ein System, und wohin?
• Abhängigkeiten vor Projekten: Was hängt an dem System, das migriert werden soll?
• Risiko: Wo laufen sensible Daten über ungesicherte Wege (z. B. direkte Datenbankzugriffe)?
• Zentrale Integrationsdienste: Welche Verbindungen laufen über ein API-Gateway, einen ESB oder ein ETL-Tool – und welche sind direkte Punkt-zu-Punkt-Verbindungen?

Eine Schnittstelle anlegen

Du hast zwei Wege – das Formular ist in beiden Fällen dasselbe:

Im Kontext einer Applikation

1. Öffne die Detailseite der Applikation, von der die Verbindung ausgeht
2. Gehe zum Abschnitt „Verbindungen"
3. Klicke auf „+ Neu"

Zentral im Inventar

1. Öffne Inventar → Schnittstellen
2. Klicke auf „Neue Schnittstelle"
3. Wähle zuerst die Quell-Applikation – also die App, von der die Verbindung ausgeht

Das Anlegen führt dich durch vier Felder.

1. Gegenstelle & Richtung

Zuerst wählst du, mit wem die App spricht. Über den Umschalter entscheidest du den Zieltyp:

• App / System – eine andere Applikation in deinem Inventar
• Externer Partner – eine Organisation außerhalb deiner IT (siehe Partner-Netzwerk)

Danach legst du den Datenfluss fest:

Richtung	Bedeutung
App A sendet an App B	Daten fließen in eine Richtung (ausgehend)
App A bekommt von App B	Daten fließen in eine Richtung (eingehend)
App A und App B halten sich synchron	Bidirektional – beide Seiten tauschen Daten aus

2. Art der Daten

Wähle, welche Art von Daten über die Verbindung läuft. Die Kategorie hilft später beim Filtern und beim Compliance-Überblick:

Kategorie	Typische Beispiele
Stammdaten	Kunden, Artikel, Kontenrahmen, Mitarbeitende
Buchungen & Bewegungsdaten	Rechnungen, Bestellungen, Buchungssätze
Anmeldung & Zugriffsrechte	Single Sign-On, Benutzerverzeichnis, Rollen
Dateien & Dokumente	PDF-Export, Dokumentenablage, Anhänge
Status & Meldungen	Statusupdates, Events, Benachrichtigungen

Anschließend kannst du das konkrete Datenobjekt benennen (z. B. „Rechnung", „Kundenstammsatz") – entweder aus den Vorschlägen wählen oder einen eigenen Begriff eingeben.

3. Verbindungsart

Lege fest, auf welchem Weg die Daten fließen:

Verbindungsart	Bedeutung
Point-to-Point	Die beiden Systeme sind direkt miteinander verbunden.
Über Gateway/ETL	Die Verbindung läuft über eine andere Applikation – z. B. ein API-Gateway, einen Enterprise Service Bus (ESB), ein ETL-Tool oder einen zentralen SFTP-Server.
Unbekannt	Der Weg ist (noch) nicht bekannt. Das ist die Voreinstellung.

Wählst du „Über Gateway/ETL", erscheint das Feld „Gateway/ETL-Applikation". Tippe den Namen ein und wähle die App aus der Trefferliste. Als Gateway kommt jede Applikation aus deinem Inventar in Frage – du musst sie vorher nicht besonders kennzeichnen. Lege dein API-Gateway oder dein ETL-Tool also einfach als ganz normale Applikation an.

Dabei gilt:

• Bei „Über Gateway/ETL" ist die Gateway-App Pflicht – ohne sie lässt sich nicht speichern.
• Quell-App und Gegenstelle können nicht selbst das Gateway sein; sie erscheinen deshalb nicht in der Trefferliste.
• Je Schnittstelle gibt es ein Gateway. Läuft eine Verbindung über mehrere Stationen, wähle die wichtigste (z. B. den ESB).
• Wechselst du später auf „Point-to-Point" oder „Unbekannt", wird die Gateway-Zuordnung automatisch entfernt.

tipp

Die Schnittstelle bleibt fachlich A → B. Das Gateway ist eine Eigenschaft der Verbindung – du legst also nicht zwei Schnittstellen „A → Gateway" und „Gateway → B" an. So bleiben Karte, Abhängigkeiten und DSGVO-Report korrekt.

4. Protokoll (optional)

Optional gibst du an, wie technisch die Verbindung läuft. Das ist für die Risikobewertung nützlich, aber kein Pflichtfeld:

Protokoll	Bedeutung
REST / HTTP	Klassische Web-/API-Schnittstelle
SAML	Anmeldung / Single Sign-On
LDAP	Benutzerverzeichnis
gRPC	Moderne Service-zu-Service-Kommunikation
Filesystem / SFTP	Dateiaustausch
Datenbank-direkt	Direkter Datenbankzugriff
Sonstiges	Alles andere

Klicke auf „Verbindung speichern" – die Schnittstelle erscheint sofort in der Liste und als Linie auf der Karte.

Verbindungen lesen und ändern

Im Abschnitt „Verbindungen" sind die Schnittstellen nach Ausgehend und Eingehend getrennt. Jede Zeile zeigt die Gegenstelle, ein Badge für die Datenkategorie und – falls gepflegt – das Protokoll. Externe Partner sind mit EXT markiert.

Dazu kommt ein Badge für die Verbindungsart:

• P2P – Point-to-Point
• via <App> – die Verbindung läuft über diese Gateway/ETL-App. Ein Klick auf das Badge öffnet die Detailseite der Gateway-App.
• Bei „Unbekannt" wird kein Badge angezeigt.

Über den Pfeil rechts klappst du die Details einer Verbindung auf. Dort stehen u. a. die Verbindungsart und – bei „Über Gateway/ETL" – die Gateway/ETL-App.

• Mit dem Stift-Symbol bearbeitest du eine Verbindung.
• Mit dem ✕ löschst du sie. Nach dem Löschen erscheint für ein paar Sekunden eine „Rückgängig"-Schaltfläche, falls du dich vertan hast.

Ein Klick auf den Namen der Gegenstelle springt direkt zu deren Detailseite.

Schnittstellen über eine Gateway-App

Auf der Detailseite einer Applikation, die als Gateway/ETL genutzt wird, erscheint zusätzlich der Abschnitt „Schnittstellen über diese App". Er listet alle Verbindungen, die über diese App laufen – jeweils Quelle → Ziel und, falls gepflegt, das Protokoll. Quelle und Ziel sind anklickbar.

Der Abschnitt ist nur eine Ansicht: Bearbeitet wird eine Schnittstelle an ihrer Quell-Applikation oder im Inventar.

So beantwortest du schnell die Frage: Was ist alles betroffen, wenn das Gateway ausfällt oder abgelöst wird?

hinweis

Eine App, die noch als Gateway genutzt wird, lässt sich nicht löschen. Leitstand zeigt dann an, über wie viele Schnittstellen sie noch verknüpft ist. Ändere bei diesen Schnittstellen zuerst die Verbindungsart oder das Gateway – oder lösche sie.

Alle Schnittstellen im Inventar

Unter Inventar → Schnittstellen siehst du alle Schnittstellen deiner Organisation in einer Tabelle – unabhängig davon, an welcher App sie gepflegt wurden.

Spalte	Inhalt
Quelle	Applikation, von der die Verbindung ausgeht
Ziel	Gegenstelle (App oder externer Partner, markiert mit EXT)
Zieltyp	Applikation oder externer Partner (über „Spalten" einblendbar)
Verbindungsart	Point-to-Point, Über Gateway/ETL oder Unbekannt
Gateway/ETL	Name der Gateway-App – ein Klick öffnet sie
Datenfluss	Quelle → Ziel, Ziel → Quelle oder bidirektional
Protokoll, Datenkategorie, Datenobjekt	wie im Formular gepflegt
Aktualisiert	Datum der letzten Änderung

Filtern: Über die Schnellfilter oberhalb der Tabelle zeigst du mit einem Klick nur Point-to-Point, Über Gateway/ETL oder Unbekannt an – die Zahl in Klammern nennt die jeweilige Anzahl. Zusätzlich stehen wie in den anderen Inventar-Tabs Filterregeln, Sortierung und Spaltenauswahl zur Verfügung.

Öffnen und bearbeiten:

• Ein Klick auf eine Zeile öffnet die Quell-Applikation.
• Mit dem Stift-Symbol bearbeitest du die Schnittstelle direkt im Inventar. Unter dem Formular findest du das Änderungsprotokoll der Schnittstelle: wer sie wann angelegt und was geändert hat.
• Mit dem Papierkorb löschst du sie (mit Sicherheitsabfrage).

Anlegen, Bearbeiten und Löschen stehen nur Nutzern mit Schreibrechten (Editor/Admin) zur Verfügung.

Schnittstellen-Report (CSV)

Für Auswertungen in Excel gibt es den Schnittstellen-Report: eine CSV-Datei mit allen Schnittstellen und ihrer Verbindungsart. Du lädst ihn herunter über

• Inventar → Schnittstellen → „Report (CSV)" oder
• Import/Export → „Schnittstellen-Report (CSV)" → „CSV herunterladen".

Zusätzlich ist er als interface_connections.csv im ZIP-Vollexport enthalten.

Spalte	Inhalt
Quell-Applikation	Name der Quell-App
Ziel	Name der Ziel-App bzw. des externen Partners
Zieltyp	Applikation oder Externer Partner
Verbindungsart	Point-to-Point, Über Gateway/ETL oder Unbekannt
Gateway/ETL-Applikation	Name der Gateway-App (leer, wenn keine)
Datenfluss	Quelle → Ziel, Ziel → Quelle (Partner sendet an die App) oder bidirektional
Protokoll	z. B. REST, SFTP, DB
Datenkategorie	z. B. Stammdaten, Buchungen & Bewegungsdaten
Datenobjekt, Frequenz, Beschreibung	wie gepflegt

Die Zeilen sind nach Quell-Applikation und Ziel sortiert. Schnittstellen, die vor Einführung der Verbindungsart angelegt wurden, erscheinen als „Unbekannt" – so siehst du sofort, wo noch nachzupflegen ist.

Häufige Fragen

Muss ich eine Verbindung auf beiden Seiten anlegen?
Nein. Du legst sie einmal an der einen App an – sie erscheint automatisch bei der Gegenstelle als eingehende bzw. ausgehende Verbindung.

Was, wenn die Schnittstelle erst geplant ist?
Du kannst sie trotzdem dokumentieren. So hältst du auch geplante oder konzeptionelle Verbindungen fest und siehst den Reifegrad deiner Integrationslandschaft.

Was ist eine Gateway/ETL-App?
Eine ganz normale Applikation aus deinem Inventar, über die Daten zwischen anderen Systemen laufen – etwa ein API-Gateway, ein ESB, ein ETL-Tool oder ein zentraler SFTP-Server. Du kennzeichnest sie nicht gesondert; sie wird zur Gateway-App, sobald du sie bei einer Schnittstelle als Gateway auswählst.

Was mache ich mit Schnittstellen, deren Verbindungsart „Unbekannt" ist?
Nichts zwingend – „Unbekannt" ist ein gültiger Zustand. Filtere im Inventar auf „Unbekannt" und ergänze die Verbindungsart nach und nach, sobald du es weißt.

Brauche ich das Protokoll?
Nein, es ist optional. Für einen High-Level-Überblick reichen Gegenstelle, Richtung und Datenart völlig aus. Das Protokoll ergänzt du nur, wenn die technische Sicht für dich relevant ist.