Was ist eine Schnittstelle (API)?

Eine Schnittstelle, meist als API bezeichnet, ist eine definierte Verbindung, über die zwei Systeme Daten und Funktionen austauschen. Sie ist das Rückgrat jeder integrierten IT-Landschaft.

Definition

Ein Application Programming Interface legt fest, welche Daten in welchem Format übergeben werden, welche Operationen möglich sind und wie Fehler zurückgemeldet werden. Der Aufrufer muss dabei nicht wissen, wie das andere System intern arbeitet. Diese Trennung ist der eigentliche Wert einer Schnittstelle: Systeme können sich unabhängig voneinander weiterentwickeln, solange der Vertrag stabil bleibt.

Verbreitete Arten

• REST: Ressourcenorientiert über HTTP, weit verbreitet und einfach zu nutzen.
• SOAP: Stark formalisiert, in älteren und behördlichen Umgebungen noch häufig anzutreffen.
• GraphQL: Der Aufrufer bestimmt, welche Felder geliefert werden.
• Dateibasierte Übergabe: Weiterhin verbreitet bei Altsystemen und Massendaten.
• Ereignisgetriebene Verfahren: Systeme reagieren auf Nachrichten statt aktiv abzufragen.

Was eine gute Schnittstelle ausmacht

• Klar dokumentiert, idealerweise maschinenlesbar.
• Versioniert, damit Änderungen bestehende Nutzer nicht brechen.
• Abgesichert durch Authentifizierung und Berechtigungsprüfung.
• Mit definiertem Verhalten bei Fehlern, Zeitüberschreitungen und Wiederholungen.
• Belastbar unter der erwarteten Last, mit Begrenzung der Aufrufhäufigkeit.

Typische Projektfalle

Schnittstellen werden regelmäßig unterschätzt. Im Plan steht eine Zeile, in der Realität stecken Abstimmungen mit einem Drittanbieter, Testdaten, Datenschutzfragen und Fehlerfälle, die niemand beschrieben hat. Wer Schnittstellen früh identifiziert und die Gegenstellen aktiv einbindet, vermeidet einen der häufigsten Gründe für Terminverzug.

Abgrenzung

Die Schnittstelle beschreibt den Vertrag zwischen Systemen. Middleware ist die Softwareschicht, die Nachrichten zwischen vielen Systemen vermittelt, umwandelt und verteilt.