Was ist eine API-Integration? Methoden und worauf Sie achten sollten

Eine API (Programmierschnittstelle) ist die Tür, die eine Software bereitstellt, um Daten mit anderer Software austauschen zu können. API-Integration bedeutet, dafür zu sorgen, dass zwei oder mehr Systeme über diese Türen automatisch miteinander kommunizieren. Dass eine Bestellung aus Ihrem Onlineshop von selbst im Buchhaltungsprogramm ankommt oder die Sendungsverfolgungsnummer automatisch an den Kunden gesendet wird, sind Beispiele für Integrationen.

Warum ist Integration notwendig?

Werden Daten von Hand zwischen Systemen übertragen, entstehen drei Probleme: Zeitverlust, Tippfehler und nicht aktuelle Daten. Mit der Zahl der Vorgänge wachsen diese Probleme. Integration sorgt dafür, dass dieselbe Information nur an einer Stelle eingegeben wird und jedes System erreicht, das sie benötigt.

Vier grundlegende Methoden

1. Echtzeitanfrage (REST-API)

Ein System fragt das andere in dem Moment, in dem es eine Information benötigt, und erhält eine Antwort. Geeignet ist das für Vorgänge wie Bestandsabfragen, das Abrufen von Preisen oder das Anlegen von Datensätzen. Heute ist dies die am weitesten verbreitete Methode.

2. Webhook (Ereignisbenachrichtigung)

Tritt ein Ereignis ein, informiert das Quellsystem die Gegenseite von sich aus. Ein Beispiel dafür ist, benachrichtigt zu werden, wenn eine Zahlung abgeschlossen ist oder sich der Versandstatus ändert. Das macht ständiges Abfragen überflüssig.

3. Zeitgesteuerte Batch-Übertragung

Die Daten werden in festgelegten Intervallen gebündelt übertragen. Nächtliche Abgleichläufe oder der dateibasierte Austausch mit Altsystemen, die keine API bieten, erfolgen mit dieser Methode. Sie arbeitet nicht in Echtzeit, ist aber einfach und robust.

4. Message Queue (Nachrichtenwarteschlange)

Vorgänge werden in eine Warteschlange geschrieben und der Reihe nach verarbeitet. Selbst wenn das Gegensystem vorübergehend nicht erreichbar ist, gehen die Nachrichten nicht verloren. Bevorzugt wird diese Methode bei hohem Transaktionsvolumen und wenn mehrere Systeme auf dasselbe Ereignis reagieren müssen.

Bedarf	Geeignete Methode
Eine sofortige Antwort ist erforderlich	Echtzeitanfrage
Informiert werden, sobald ein Ereignis eintritt	Webhook
Große Datenmengen, zeitlich flexibel	Batch-Übertragung
Hohes Transaktionsvolumen, Robustheit bei Ausfällen	Message Queue

Worauf es bei einer zuverlässigen Integration ankommt

• Robustheit bei Wiederholungen: Trifft dieselbe Anfrage zweimal ein, darf die Bestellung nicht doppelt angelegt werden. Vorgänge sollten so konzipiert sein, dass sie bei Wiederholung dasselbe Ergebnis liefern.
• Wiederholungsversuche: Bei vorübergehenden Fehlern sollte der Vorgang in zunehmend größeren Abständen erneut versucht werden.
• Anfragelimits: Die meisten APIs begrenzen die Zahl der Anfragen, die in einem bestimmten Zeitraum gestellt werden können. Die Integration sollte nach diesen Limits geplant werden.
• Authentifizierung: API-Schlüssel und Zugriffstoken sollten sicher aufbewahrt und nur mit den erforderlichen Berechtigungen ausgestattet werden.
• Protokollierung und Monitoring: Es sollte sichtbar sein, welcher Vorgang wann ausgeführt wurde und warum er fehlgeschlagen ist. Für den Fehlerfall sollte eine automatische Warnmeldung eingerichtet werden.
• Versionsänderungen: Die API der Gegenseite ändert sich mit der Zeit. Versionsankündigungen sollten verfolgt werden, und man sollte auf Änderungen vorbereitet sein.
• Daten-Mapping: Dasselbe Konzept kann in zwei Systemen unterschiedlich benannt oder in unterschiedlicher Form gespeichert sein. Wie die Felder einander zugeordnet werden, sollte von Anfang an dokumentiert werden.

Was tun bei Systemen ohne API?

Nicht jede Software bietet eine API. In diesem Fall werden Optionen wie Dateiübertragung, Lesezugriff auf Datenbankebene oder ein zwischengeschalteter Vermittlungsdienst geprüft. Jede davon birgt ein anderes Risiko; die vom Softwarehersteller unterstützte Methode sollte stets die erste Wahl sein.

Fragen, die vor dem Start beantwortet sein sollten

1. Welche Daten fließen in welche Richtung und wie häufig?
2. Die Daten welches Systems gelten bei einem Konflikt als korrekt?
3. Gibt es für das Gegensystem eine Dokumentation und eine Testumgebung?
4. Wie wird die Arbeit fortgeführt, wenn die Integration stillsteht?
5. Wer überwacht die Fehler, und wer greift ein?

Um Ihre Systeme miteinander zu verbinden, können Sie sich unsere Leistung API- und Systemintegrationen ansehen.