API-Schnittstelle: einfach erklärt, mit Beispielen aus dem Unternehmen

Was ist eine API-Schnittstelle?

Eine API-Schnittstelle ist eine festgelegte Verbindung, über die zwei Programme Daten austauschen und Funktionen nutzen können, ohne dass ein Mensch etwas abtippt. API steht für Application Programming Interface, auf Deutsch Programmierschnittstelle.

Man kann sich eine API wie den Schalter einer Behörde vorstellen. Sie müssen nicht wissen, wie es hinter dem Schalter organisiert ist. Sie stellen einen Antrag in der vorgesehenen Form und bekommen eine Antwort in einer festen Form zurück. Genauso fragt ein Programm über die API nach einem Kunden oder legt einen Auftrag an, ohne die Datenbank des anderen Programms direkt anzufassen.

Für Unternehmen ist das der wichtigste Weg, Systeme zu verbinden. Wenn der Onlineshop Bestellungen an die Auftragsverwaltung übergibt oder ein Auswertungswerkzeug Umsätze abruft, geschieht das in aller Regel über eine API.

Wie eine Anfrage über die API abläuft

Eine API arbeitet nach dem Prinzip Anfrage und Antwort. Das anfragende Programm schickt eine Anfrage an eine Adresse, den sogenannten Endpunkt. Es sagt dazu, was es will: lesen, anlegen, ändern oder löschen. Das andere Programm prüft, ob die Anfrage erlaubt ist, und antwortet mit Daten oder einer Fehlermeldung.

Die Daten werden dabei meist im JSON-Format übertragen, einer einfachen Textform aus Feldnamen und Werten. Ein vereinfachtes Beispiel für das Abrufen eines Kunden:

REST, OData, Webhook: die gängigen Formen

API ist ein Oberbegriff. In der Praxis begegnen Ihnen einige wenige Formen immer wieder. Sie schließen sich nicht aus, viele Systeme bieten mehrere davon an.

Lieber direkt mit Fachleuten sprechen? Erstgespräch buchen

Authentifizierung und Rechte bei der API-Anbindung

Eine API öffnet Ihr System für andere Programme. Deshalb muss jede Anfrage zeigen, wer sie stellt. Üblich ist ein API-Schlüssel oder ein Token, das im Kopf jeder Anfrage mitgeschickt wird. Bei Verfahren wie OAuth2 meldet sich ein Programm im Namen eines Benutzers an, ohne dessen Passwort zu kennen.

Genauso wichtig wie die Anmeldung sind die Rechte. Ein Schlüssel sollte nur das dürfen, was die Anbindung braucht. Ein Auswertungswerkzeug braucht Lesezugriff, aber kein Schreibrecht. Der Onlineshop darf Aufträge anlegen, aber keine Einkaufspreise sehen. Geben Sie jeder Anbindung einen eigenen Schlüssel. Dann können Sie einen Zugang sperren, ohne alle anderen zu stören, und sehen, welches Programm was geändert hat.

Schlüssel gehören nicht in E-Mails, Tabellen oder Quelltexte, die viele lesen können. Wird ein Schlüssel nicht mehr gebraucht, sperren Sie ihn.

Beispiele für API-Integration im Unternehmen

Wo eine API-Integration im Alltag hilft, zeigen typische Fälle. In allen ersetzt die Schnittstelle das Abtippen oder Kopieren zwischen zwei Programmen.

Eine API-Anbindung beginnt fast immer mit denselben Fragen: Welches System ist für welche Daten führend? Welche Daten fließen in welche Richtung? Bei welchem Ereignis soll die Übertragung stattfinden, und was passiert, wenn sie scheitert? Wer das vorab klärt, spart später Nacharbeit.

API, Schnittstelle und EDI: die Begriffe abgegrenzt

Schnittstelle ist der weitere Begriff. Er meint jede Stelle, an der zwei Systeme zusammenkommen, auch einen Dateiaustausch oder eine Druckerverbindung. Eine API ist eine Schnittstelle, die für Programme gemacht ist und genau festlegt, welche Anfragen erlaubt sind. Im Alltag werden die Wörter oft gleich verwendet. Die Bezeichnung API-Schnittstelle ist streng genommen doppelt, denn das I in API steht bereits für Interface, also Schnittstelle.

EDI steht für Electronic Data Interchange, den elektronischen Austausch von Geschäftsdokumenten wie Bestellungen, Lieferavisen und Rechnungen in genormten Formaten zwischen Unternehmen. EDI ist älter als die meisten Web-APIs und läuft oft über feste Übertragungswege. Eine API ist offener: Sie ist nicht auf Belege beschränkt und antwortet auf jede einzelne Anfrage.

Woran Sie eine gute API erkennen

Ob eine Anbindung mit wenig Aufwand gelingt, hängt stark von der Qualität der API ab. Diese Punkte sollten Sie bei jedem System prüfen, das Sie anbinden wollen oder neu einführen:

Die API als Werkzeug für KI-Assistenten

KI-Assistenten werden zunehmend über APIs an Unternehmenssoftware angebunden. Der Assistent liest über die Schnittstelle, wie ein System aufgebaut ist, fragt Daten ab oder bereitet Änderungen vor. Eine gut beschriebene API mit klaren Rechten ist dafür die Voraussetzung.

Für den KI-Zugang gelten dieselben Regeln wie für jede andere Anbindung, nur strenger: ein eigener Schlüssel, so wenige Rechte wie möglich und Änderungen, die ein Mensch prüft und freigibt, bevor sie wirken. Was ein KI-Assistent über die API tut, sollte nachvollziehbar sein wie jede andere Änderung.

REST-API je Objekt in XGait

XGait ist ein Framework für Unternehmenssoftware nach Maß. Jedes Objekt, das wir für Sie einrichten, ist automatisch über die REST-API erreichbar. Die Endpunkte entstehen aus dem Schema, programmiert wird dafür nichts: Datensätze lesen, filtern, auswerten, anlegen, ändern und löschen, im Stapel bis zu 200 Datensätze in einem Aufruf, dazu die Änderungshistorie und die freigeschalteten Aktionen eines Objekts.

Unter /api/v1/objects sehen Sie alle Objekte, unter /api/v1/objects/{id} das Schema eines Objekts mit Feldern und Status. Die ganze API ist als OpenAPI-Beschreibung unter /api/v1/openapi.json abrufbar. Für Auswertungswerkzeuge gibt es einen lesenden OData-Zugang, und Webhooks melden Ereignisse signiert an andere Systeme.

Was ein API-Schlüssel darf, legen Sie fest: welche Objekte er lesen darf und ob er schreiben darf. Schreiben setzt ein ausdrücklich vergebenes Schreibrecht voraus, und Prüfregeln gelten auch für Schreibzugriffe über die API. Andere Systeme binden wir über Konnektoren für REST, GraphQL oder SOAP an, auch aus einer OpenAPI-Beschreibung. Ausgenommen sind Bank- und Zahlungsschnittstellen, DATEV-Online, E-Rechnung und Behördenschnittstellen wie ELSTER.

Externe KI-Assistenten können Sie mit einem eigenen Zugang über die API anbinden. Was der Assistent dort tut, gilt als Handlung Ihres Unternehmens, und Sie prüfen jeden Vorschlag vor der Umsetzung. Standardmäßig ist in XGait keine KI aktiv.

Ihr Weg zur API-Anbindung mit XGait

Welche Systeme Sie anbinden wollen, gehen wir im Erstgespräch Punkt für Punkt durch. Danach nehmen wir Ihre Abläufe und Ihre Systemlandschaft auf, und Sie erhalten einen Umsetzungsvorschlag mit Festpreis. Wir richten die Objekte und die Anbindungen ein, Sie testen und geben frei.

Was Ihr Ablauf braucht, bauen wir. Was die Plattform noch nicht kann, ergänzen wir.

Wie das für Ihre Abläufe aussieht, zeigen wir Ihnen gern. Erstgespräch buchen