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)?
Eine Schnittstelle anlegen
Schnittstellen werden immer im Kontext einer Applikation gepflegt – nicht auf einer eigenen Seite.
- Öffne die Detailseite der Applikation, von der die Verbindung ausgeht
- Gehe zum Abschnitt „Verbindungen"
- Klicke auf „+ Neu"
Das Anlegen führt dich durch drei 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. 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.
- 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.
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.
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.