Der Shop meldet eine Bestellung, die Buchhaltung weiß davon nichts, und jemand tippt die Zahlen am Abend ab. Dafür gibt es eine Lösung: die API-Schnittstelle. Dieser Beitrag erklärt für Inhaber und Geschäftsführer kleiner und mittlerer Betriebe, was eine API ist, wie sie funktioniert, wann sie sich lohnt und was vor dem Bau geklärt sein sollte. Technikkenntnisse sind nicht nötig.
Was ist eine API-Schnittstelle?
Eine API (Application Programming Interface) ist eine Vereinbarung, über die ein Programm einem anderen Daten oder Funktionen zur Verfügung stellt. MDN, die Dokumentation für Webtechnik der Mozilla-Gemeinschaft, beschreibt eine API als Regeln und Funktionen, mit denen sich ein Programm per Software nutzen lässt statt über eine Oberfläche für Menschen. Man kann sie als Vertrag zwischen dem anbietenden Programm und anderen Programmen verstehen.
Ein Mensch klickt in einem Programm auf Schaltflächen. Eine andere Software nutzt stattdessen die API: Sie fragt zum Beispiel „Welche Bestellungen sind seit gestern eingegangen?“ und bekommt eine Antwort in einem festen Format. Der Ablauf geschieht ohne Mausklick, deshalb lässt er sich automatisieren.
| Beispiel (allgemein) | Was die API übermittelt | Was der Betrieb davon hat |
|---|---|---|
| Onlineshop und Buchhaltung | Bestellungen und Rechnungsdaten | Keine doppelte Eingabe |
| Kontaktformular der Website und Kundenverwaltung | Name, Anliegen, Eingangsdatum | Anfragen landen ohne Abtippen am richtigen Ort |
| Terminbuchung und Kalender | Gebuchte Termine | Keine Doppelbuchungen |
| Warenwirtschaft und Versanddienst | Lieferadressen | Versandetiketten ohne Handarbeit |
Die Beispiele zeigen übliche Anwendungen. Ob Ihre Programme eine API anbieten, hängt vom jeweiligen Hersteller ab.
Wie tauschen Programme über eine API Daten aus?
Der Austausch läuft über Anfrage und Antwort: Ein Programm fragt an, das andere liefert die Daten in einem festen Format. Damit nicht jeder zugreifen kann, verlangt die API in der Regel einen Zugangsschlüssel, mit dem sich das anfragende Programm ausweist. Welche Daten abrufbar sind und wie die Anfrage aussieht, steht in der Dokumentation des Anbieters.
Wann ruft ein Programm Daten ab, und wann meldet sich das andere?
Es gibt zwei übliche Wege, die sich im Aufwand und in der Aktualität unterscheiden:
- Abruf. Ein Programm fragt in festen Abständen nach, etwa alle fünf Minuten oder einmal nachts. Das ist einfach und reicht für vieles.
- Benachrichtigung. Das andere Programm meldet selbst, sobald etwas passiert, zum Beispiel bei einer neuen Bestellung. Dafür gibt es den Begriff Webhook. Die Daten kommen schneller an, die Einrichtung ist meist aufwendiger.
Welche Variante passt, hängt davon ab, wie schnell die Daten im Zielprogramm sein müssen. Für eine tägliche Abrechnung genügt ein nächtlicher Abruf, für eine Terminbuchung zählt jede Minute.
Wann lohnt sich eine Schnittstelle für Ihren Betrieb?
Eine Schnittstelle lohnt sich, wenn dieselben Daten regelmäßig und in gleicher Weise von einem Programm ins andere übertragen werden. Das sind typische Anzeichen:
- Sie tippen Daten aus einem Programm in ein zweites ab.
- Sie kopieren regelmäßig Exportdateien von einem System ins andere.
- Zahlen in zwei Programmen weichen voneinander ab, weil eine Übertragung vergessen wurde.
- Eine Aufgabe wiederholt sich wöchentlich oder täglich und folgt immer denselben Schritten.
Als Faustregel gilt: Läuft eine Aufgabe regelmäßig gleich ab und kostet sie pro Woche mehr als eine Stunde, rechnet sich ein Skript oder eine Anbindung meist innerhalb weniger Monate. Das ist ein Erfahrungswert von PJE Systems, keine Marktstatistik. Rechnen Sie für Ihren Betrieb selbst nach: Wie oft fällt die Aufgabe an, wie lange dauert sie, und was kostet ein Fehler?
Welche Software ohnehin passt, klärt der Beitrag Individualsoftware oder Standardsoftware: Was lohnt sich?. Eine Schnittstelle ist oft der kleinste sinnvolle Eingriff: Sie behalten Ihre Programme und schließen nur die Lücke dazwischen.
Wann reicht ein Export statt einer API?
Ein Export reicht, wenn Sie Daten nur selten abgleichen und der Zeitaufwand gering ist. Viele Programme können Daten als CSV-Datei, also als einfache Tabelle, ausgeben und in ein anderes Programm einlesen. Das ist ohne Entwicklung möglich.
| Weg | Aufwand beim Einrichten | Aktualität der Daten | Passt, wenn |
|---|---|---|---|
| Export und Import von Hand | Gering | Nur so aktuell wie Ihr letzter Abgleich | Der Abgleich selten nötig ist |
| Fertige Anbindung des Herstellers | Gering bis mittel, oft Teil des Tarifs oder Zusatzkosten | Meist automatisch | Beide Programme sie anbieten und sie Ihren Ablauf abdeckt |
| Eigene Anbindung über die API | Mittel, einmalig | Automatisch, je nach Ablauf in Minuten oder nachts | Kein fertiger Weg existiert oder er Ihren Ablauf nicht trifft |
Prüfen Sie zuerst, ob ein Hersteller selbst eine Anbindung anbietet. Eine eigene Anbindung lohnt, wenn keine fertige existiert, wenn sie Ihren Ablauf nicht abdeckt oder wenn sie dauerhaft mehr kostet als die Arbeit, die sie ersetzt.
Worauf achten Sie bei Sicherheit und Datenschutz?
Bei einer API achten Sie auf drei Dinge: geschützte Zugangsschlüssel, möglichst wenige Rechte und eine Regel für den Fehlerfall. Die gemeinnützige Organisation OWASP führt eine Liste der zehn größten Risiken von APIs. Sie nennt zum Beispiel fehlerhafte Anmeldung, zu weitreichende Zugriffsrechte, ungeschützte Zugänge zu Geschäftsabläufen und veraltete Schnittstellenversionen. Für Betriebe lässt sich daraus ableiten:
- Zugangsschlüssel geheim halten. Ein Schlüssel ist wie ein Passwort und gehört in einen Passwort-Manager oder in die geschützte Konfiguration, nicht in eine E-Mail oder in eine Datei auf dem Desktop.
- So wenige Rechte wie nötig. Wenn die Anbindung nur Bestellungen lesen muss, bekommt sie kein Recht zum Löschen.
- Zugriffe begrenzen und beobachten. OWASP nennt unbegrenzte Anfragen als eigenes Risiko, weil sie Kosten verursachen oder einen Dienst lahmlegen können. Ein Protokoll zeigt, wann etwas ausfällt.
- Fremden Daten nicht blind vertrauen. Auch Daten aus einem Partnerdienst sollten geprüft werden, bevor sie weiterverarbeitet werden. OWASP führt das als eigenes Risiko.
- Versionen im Blick behalten. Hersteller ändern ihre APIs. Wer Änderungen nicht verfolgt, bemerkt einen Ausfall erst, wenn Daten fehlen.
Was gilt, wenn personenbezogene Daten fließen?
Fließen über die Schnittstelle personenbezogene Daten, etwa Namen oder Adressen von Kunden, gilt die Datenschutz-Grundverordnung. Prüfen Sie, ob der Dienst, der die Daten verarbeitet, dafür einen Vertrag zur Auftragsverarbeitung anbietet. Er ist in Art. 28 der DSGVO geregelt. Klären Sie außerdem, wo der Dienst die Daten speichert. Dieser Abschnitt ist eine Übersicht, keine Rechtsberatung. Für verbindliche Aussagen wenden Sie sich an eine Datenschutz- oder Rechtsberatung.
Was klären Sie, bevor eine Schnittstelle gebaut wird?
Vor dem Bau klären Sie den Datenfluss, den Zugang, den Fehlerfall und die Pflege. Mit diesen sechs Schritten wird ein Vorhaben planbar:
- Datenfluss beschreiben. Schreiben Sie auf, von welchem Programm nach welchem Programm welche Daten fließen, welche Felder es sind und wie oft.
- Dokumentation prüfen. Suchen Sie beim Hersteller nach der API-Dokumentation. Fehlt sie, fragen Sie nach, ob eine Anbindung vorgesehen ist.
- Zugang und Tarif klären. Manche Hersteller schalten die API nur in bestimmten Tarifen frei oder verlangen eine Freigabe. Prüfen Sie das vor der Beauftragung.
- Fehlerfall festlegen. Entscheiden Sie, was passiert, wenn eines der Programme nicht erreichbar ist: erneut versuchen, melden oder abbrechen. Eine Anbindung sollte Ausfälle protokollieren, statt still zu scheitern.
- Mit echten Beispielen testen. Prüfen Sie einige reale Fälle, auch Sonderfälle wie Umlaute, Stornos oder leere Felder.
- Pflege einplanen. Wenn sich Programme ändern, muss die Anbindung folgen. Rechnen Sie dafür etwas Zeit ein, ebenso wie bei einer Website, siehe Website-Wartung.
Ein Dienstleister kann den Aufwand erst abschätzen, wenn Schritt 1 und 2 vorliegen. Je klarer diese Angaben sind, desto genauer wird die Schätzung.
Was kostet eine Schnittstelle?
Der Preis hängt vom Aufwand ab, nicht von der Zahl der Zeilen Programmcode. Entscheidend sind die Qualität der Dokumentation, die Zahl der Datenfelder, die Fehlerbehandlung und der Umfang der Tests. Eine allgemeine Preisspanne für den Markt lässt sich deshalb seriös nicht nennen.
Bei PJE Systems steht auf der Seite Preise ein Startpreis: Eine API-Anbindung beginnt ab 80 €, die Arbeitszeit kostet 50 € pro Stunde. Nach dem ersten Gespräch bekommen Sie eine Aufwandsschätzung mit Preisrahmen, bevor etwas entwickelt wird.
Nächster Schritt
Schreiben Sie auf, welche Daten Sie heute regelmäßig von Hand zwischen zwei Programmen übertragen, wie oft das vorkommt und wie lange es dauert. Mit dieser Notiz lässt sich beurteilen, ob sich eine Anbindung lohnt. Welche Aufgaben die Softwareentwicklung umfasst, steht auf der Seite Softwareentwicklung, alle Angebote finden Sie unter Leistungen. Wenn Sie Ihren Fall besprechen möchten, beschreiben Sie ihn kurz über die Seite Kontakt.