Was ist eine API? Schnittstellen verständlich erklärt

Eine Schnittstelle ist eine Vereinbarung

Wenn ein Shop eine Bestellung an die Warenwirtschaft übergibt, sprechen die beiden Systeme nicht einfach miteinander. Es gibt eine festgelegte Stelle, an der das eine System etwas anfragen kann, eine festgelegte Form für diese Anfrage, eine festgelegte Form für die Antwort — und eine Vereinbarung, was gilt, wenn etwas fehlt.

Diese Vereinbarung ist die Schnittstelle, auf Englisch Application Programming Interface, kurz API. Der technische Teil ist dabei oft der einfachere. Der schwierige Teil ist die Einigung darüber, welche Felder verpflichtend sind, welche Werte zulässig sind und wer bei Widersprüchen entscheidet.

Wie eine Anfrage abläuft

Drei Dinge fallen an dieser Darstellung auf. Erstens: Die Schnittstelle prüft, bevor sie weitergibt — sonst landen fehlerhafte Daten im Zielsystem. Zweitens: Sie übersetzt, weil zwei Systeme dieselbe Sache fast nie gleich benennen. Drittens: Sie antwortet auch im Ablehnungsfall, und zwar mit einem Grund.

Abfragen oder benachrichtigt werden

Es gibt zwei Grundmuster, und die Wahl zwischen ihnen hat praktische Folgen.

• Abfrage: Ihr System fragt regelmäßig nach — „gibt es neue Bestellungen?“. Einfach zu bauen, robust gegenüber Ausfällen, aber mit Verzögerung und unnötigen Abfragen.
• Benachrichtigung: Das andere System meldet sich, sobald etwas passiert — oft Webhook genannt. Schnell und sparsam, braucht aber eine erreichbare Adresse auf Ihrer Seite und einen Plan für verlorene Meldungen.

In der Praxis werden beide oft kombiniert: Benachrichtigungen für den Normalfall, eine regelmäßige Abfrage als Netz darunter. Diese Doppelung ist kein Mehraufwand ohne Grund — sie ist die Antwort auf die Frage, was bei einer verlorenen Meldung passiert.

Der Fehlerfall ist die halbe Arbeit

Eine Schnittstelle, die im Normalfall funktioniert, ist halb fertig. Dazu gehören:

• Erkennbare Fehlerantworten: nicht „Fehler“, sondern welches Feld und warum.
• Wiederholbarkeit: dieselbe Meldung zweimal zugestellt darf nicht zwei Vorgänge erzeugen.
• Nachvollziehbarkeit: Was wurde wann übertragen, und was kam zurück?
• Eine Stelle für Hoffnungslose: Vorgänge, die auch nach mehreren Versuchen scheitern, müssen jemandem auffallen.

Diese vier Punkte unterscheiden eine Schnittstelle, die man betreiben kann, von einer, die funktioniert, solange niemand hinsieht.

Sechs Fragen vor jeder Schnittstelle

• Welches System führt? Bei widersprüchlichen Daten muss eine Seite gewinnen.
• Welche Felder sind verpflichtend, und welche Werte sind zulässig?
• Wie wird sich angemeldet, und wer verwaltet die Zugangsschlüssel?
• Wie oft und in welcher Menge wird übertragen? Gibt es Mengenbegrenzungen?
• Was passiert bei einer Ablehnung — erneut versuchen, verwerfen, jemanden informieren?
• Wer merkt, wenn die Verbindung drei Tage nicht gelaufen ist?

Wer diese sechs Fragen vor dem Bauen beantwortet, hat den schwierigen Teil hinter sich. Wer sie überspringt, beantwortet sie später im Betrieb — unter Zeitdruck.