Eine API ist eine definierte Softwareschnittstelle
Eine Programmierschnittstelle (Application Programming Interface, API) beschreibt, wie ein Softwaresystem Informationen anfragen oder ein anderes System um eine Aktion bitten kann. Sie legt verfügbare Vorgänge, Aufbau von Anfragen und Antworten sowie häufig Regeln für Authentifizierung und Fehler fest. Sie ist ein Vertrag zwischen Softwarekomponenten und keine magische Verbindung zwischen Produkten.
Ein Unternehmen kann über eine API eine Website-Anfrage an ein CRM senden, den Lieferstatus von einem Logistikdienst abrufen oder einen Zahlungsdienst mit einem Onlineshop verbinden. So können Systeme kommunizieren, ohne dass jemand jede Information von Hand kopieren muss.
Ein typischer API-Ablauf
Vereinfachtes Beispiel: Der Browser fragt Produkte an, der Server liest die Daten und sendet strukturiertes JSON zurück. In realen Systemen kommen oft Authentifizierung, Prüfung, Caching oder weitere Dienste hinzu.
Browser
Eine Person öffnet eine Produktseite.
GET /productsAPI
Der Endpunkt nimmt die Anfrage entgegen und prüft sie.
Anwendung
Der Server wendet Geschäftsregeln an und fordert die benötigten Daten an.
Datenbank
Passende Produktdatensätze gehen zurück an die Anwendung.
Antwort
Der Server sendet ein strukturiertes Ergebnis zurück an den Browser.
200 OK · application/jsonBrowser
Die Seite zeigt die Produkte anhand der Antwort an.
Eine Integration braucht Zuordnung und Verantwortung
Zwei Systeme verwenden für denselben Begriff möglicherweise andere Namen, Formate oder Definitionen. Ein Werkzeug speichert eine Telefonnummer als freien Text, ein anderes erwartet eine Ländervorwahl. Ein System betrachtet eine Person als Kunden, ein anderes ein Konto. Eine Integration muss Felder zuordnen und festlegen, was bei fehlenden Werten geschieht.
Außerdem braucht es eine geschäftlich verantwortliche Person, die entscheiden kann, was bei Änderungen des verbundenen Prozesses geschehen soll. APIs werden weiterentwickelt, Zugangsdaten laufen ab, Ratenlimits greifen und Anbieter stellen Endpunkte ein. Ohne Zuständigkeit kann eine Verbindung nach der ursprünglichen Umsetzung unbemerkt ausfallen.
Authentifizierung und minimale Rechte beachten
Viele APIs benötigen einen Schlüssel oder Token, um die Berechtigung einer Anfrage nachzuweisen. Solche Zugangsdaten sollten sicher gespeichert, auf notwendige Vorgänge beschränkt und nach den Empfehlungen des Anbieters erneuert werden. Sie gehören weder in öffentlich ausgelieferten Website-Code noch in Nachrichten oder die Versionsverwaltung.
Zu prüfen ist, welche Informationen eine Integration lesen und verändern darf. Muss sie nur einen Lead anlegen, sollte sie keinen Administratorzugriff auf sämtliche CRM-Objekte erhalten. Für unterschiedliche Umgebungen sind getrennte Zugangsdaten zu verwenden; außerdem muss klar sein, wie sich der Zugriff bei Projektende oder Anbieterwechsel widerrufen lässt.
Fehler einplanen und Ergebnisse prüfen
Eine erfolgreiche HTTP-Antwort bedeutet nicht immer, dass der Geschäftsprozess korrekt abgeschlossen wurde. Der Empfänger kann eine Anfrage annehmen und einen Datensatz später ablehnen; eine Wiederholung kann doppelte Einträge erzeugen. Statusmeldungen sollten ausgewertet, sichere Wiederholungen entworfen und genügend Protokolle für die Diagnose eines fehlgeschlagenen Übergangs geführt werden.
Bei einer Integration sollten folgende Fragen beantwortet werden: Welches System ist für welche Daten maßgeblich? Wie fließen Änderungen in beide Richtungen? Wie werden Konflikte gelöst? Wer überwacht Fehler? Klare Antworten sind nützlicher als eine lange Liste unterstützter Verbindungen.
Quellen und weiterführende Informationen
Einen sachlichen Fehler melden oder eine Quelle vorschlagen? Redaktion kontaktieren.
