Was bedeutet API (Programmierschnittstelle)?
Eine API ist eine Sammlung von Funktionen und Regeln, über die Software mit einer Anwendung zusammenarbeitet – im Unterschied zur Bedienoberfläche, die für Menschen gedacht ist. Sie lässt sich als Vertrag verstehen: Die anbietende Anwendung legt fest, welche Anfragen sie annimmt, welche Angaben dafür nötig sind und in welcher Form die Antwort zurückkommt. Wie das Programm intern arbeitet, muss die nutzende Seite dafür nicht kennen.
Web-APIs werden über HTTP angesprochen. Ein Client, etwa eine Website oder ein automatisierter Workflow, schickt eine Anfrage an einen Endpunkt, also an eine bestimmte Adresse der API. Die Methode gibt an, was geschehen soll: GET ruft den aktuellen Stand einer Ressource ab, etwa eines Kundendatensatzes; POST übergibt Daten zur Verarbeitung, beispielsweise um einen neuen Datensatz anzulegen. Der Server antwortet mit einem dreistelligen Statuscode und je nach Anfrage mit Daten, zum Beispiel im textbasierten Format JSON. Der Statuscode zeigt das Ergebnis: 401 bedeutet, dass gültige Anmeldedaten fehlen, 403, dass der Server die Ausführung verweigert, und 429, dass in kurzer Zeit zu viele Anfragen eingegangen sind.
Geschützte APIs verlangen eine Anmeldung, zum Beispiel über einen API-Schlüssel oder über OAuth 2.0. Welche Endpunkte, Felder, Anmeldeverfahren und Fehlerantworten es gibt, steht in der Dokumentation des Anbieters. Web-APIs lassen sich außerdem maschinenlesbar nach der OpenAPI Specification beschreiben. Aus einer solchen Beschreibung können Werkzeuge eine Dokumentation erzeugen, Tests unterstützen und Programmcode für Client und Server generieren.
Zu einer API gehören Grenzen, die im Betrieb schnell spürbar werden. Ein Zugang erhält nur bestimmte Rechte zum Lesen oder Ändern, und die API sollte diese Rechte bei jedem Zugriff auf einen einzelnen Datensatz prüfen. Anbieter können begrenzen, wie oft und in welchem Umfang angefragt werden darf. Neue Versionen können Endpunkte oder Felder verändern; ältere werden als veraltet gekennzeichnet und später womöglich abgeschaltet. Außerdem kann ein Dienst langsam antworten oder ausfallen. Wer eine API nutzt, plant Rechte, Limits, Versionswechsel und Ausfälle deshalb von Anfang an mit ein.
Ein Beispiel aus dem Betrieb
Angenommen, ein Malerbetrieb möchte auf seiner Website freie Termine aus seinem Online-Kalender anzeigen. Die Kalender-API bietet dafür einen Endpunkt, der belegte Zeiten für einen Zeitraum als JSON zurückgibt. Die Website fragt diesen Endpunkt über den eigenen Server mit einem Zugang an, der nur lesen darf; der API-Schlüssel gelangt dabei nicht in den Browser. Antwortet der Dienst mit dem Statuscode 429, wartet die Website die vom Dienst genannte Zeit ab und zeigt bis dahin einen Hinweis statt veralteter Termine.
Worauf Sie achten sollten
- Die Dokumentation beschreibt Endpunkte, Pflichtfelder, Formate und Fehlerantworten für genau die Daten, die Sie brauchen.
- Der Zugang erhält nur die nötigen Rechte; Schlüssel und Tokens liegen geschützt auf dem Server, nicht im Quelltext oder im Browser.
- Limits für Anfragen und Datenmengen sind bekannt und im eigenen Ablauf berücksichtigt.
- Für Zeitüberschreitungen, Fehlerantworten und Ausfälle gibt es einen festgelegten Weg, damit Fehler sichtbar werden.
- Schreibende Anfragen sind so gebaut, dass eine Wiederholung keine doppelten Datensätze erzeugt.
- Es ist geklärt, wie lange die genutzte API-Version unterstützt wird und wie der Anbieter Änderungen ankündigt.
Wo die Grenzen liegen
Eine API ist die Schnittstelle, die ein Programm oder Dienst anbietet. Eine API-Integration nutzt eine oder mehrere APIs, um konkrete Systeme zu verbinden, samt Datenzuordnung, Fehlerweg und Überwachung. Ein Webhook arbeitet in umgekehrter Richtung: Bei einer API fragt Ihr System an und erhält eine Antwort, ein Webhook meldet sich von sich aus, sobald beim anderen Dienst ein Ereignis eintritt. Dass eine Software eine API hat, heißt außerdem nicht, dass alle benötigten Daten und Aktionen darüber erreichbar sind; das zeigen erst die Dokumentation und ein Test mit dem eigenen Zugang.
Verwandte Begriffe
-
API-Integration
Eine API-Integration verbindet zwei Systeme über eine dokumentierte technische Schnittstelle und festgelegte Daten- und Fehlerverträge.
-
Webhook
Ein Webhook ist eine HTTP-Nachricht, die ein System bei einem Ereignis aktiv an eine vorher festgelegte Empfängeradresse sendet.
-
Idempotenz
Idempotenz bedeutet, dass dieselbe fachliche Operation mehrfach angefordert werden kann, ohne ihre beabsichtigte Wirkung mehrfach auszulösen.
-
Rollen und Berechtigungen
Ein Rollen- und Berechtigungskonzept legt fest, wer in einer Anwendung welche Daten sehen und welche Handlungen ausführen darf.
-
n8n
n8n ist ein Werkzeug zur Workflow-Automatisierung: Ein Auslöser startet einen Ablauf, dessen Schritte Daten zwischen Programmen übertragen, prüfen und weiterverarbeiten – als Cloud-Dienst oder auf eigenem Server.
Passende Leitfäden und Leistungen
-
CRM, Buchhaltung und Shop verbinden
Vorhandene Programme über geeignete Schnittstellen verbinden; Datenfelder, Zugriffe und Fehlerfälle werden vorher geklärt.
-
Eigene API entwickeln lassen
Eine eigene REST- oder GraphQL-Schnittstelle mit festgelegten Zugriffen, Fehlerantworten, Dokumentation und Betrieb.
-
n8n-Workflow erstellen
Einsteigeranleitung mit Aktions-Nodes, Zugangsdaten, Rate-Limits und Fehlerbehandlung für Anfragen an externe APIs.
