Dein CRM bietet eine API zum Lesen von Kontakten. Du möchtest darüber aber Aufträge anlegen. Ob das möglich ist, musst du für genau diese Operation prüfen; unter Umständen gehört sie zu einem anderen Tarif oder fehlt ganz.

Beschreibe zunächst eine konkrete Übertragung: Aus welcher Anwendung kommt welcher Datensatz, und was soll im Ziel damit passieren? Ein Beispiel mit anonymisierten Feldern ist dafür hilfreicher als der allgemeine Wunsch, zwei Systeme zu verbinden.

Prüfe die benötigte Operation

Eine API stellt bestimmte Operationen bereit, sogenannte Endpunkte. Für eine Anbindung brauchst du die Dokumentation genau der Operationen, die dein Ablauf verwendet. Kontaktdaten abrufen, einen Kontakt ändern und einen Auftrag anlegen sind getrennte Fähigkeiten.

Halte fest, welche Felder Pflicht sind und welche Werte das Ziel akzeptiert. Gibt es eine feste Liste von Statuswerten? In welcher Zeitzone wird ein Datum erwartet? Ist ein Geldbetrag eine Zahl in Euro oder ein ganzzahliger Centbetrag? Solche Unterschiede sehen in einer Beispieldatei klein aus, verändern aber das Ergebnis.

Kläre außerdem, ob eine Testumgebung vorhanden ist und ob ihr dort selbst Daten anlegen dürft. Zugangsdaten gehören in einen vereinbarten geschützten Übergabeweg. Ein API-Schlüssel im allgemeinen Kontaktformular oder einem Screenshot ist für die erste Umfangsklärung unnötig.

Was passiert, wenn die Antwort fehlt?

Fiktiver Fall: Eine Anfrage legt erfolgreich einen Vorgang im Zielsystem an. Bevor die Antwort zurückkommt, bricht die Verbindung ab. Die eigene Anwendung weiß jetzt nicht, ob der Vorgang existiert. Ein sofortiger zweiter Schreibversuch kann einen doppelten Eintrag erzeugen.

Lege fest, wie die Anwendung nach einer fehlenden Antwort weiterarbeitet. Ein vom Anbieter unterstützter Wiederholungsschlüssel oder eine Suche über die externe Vorgangskennung kann das bereits gespeicherte Ergebnis auffindbar machen. Fehlt beides, muss der unklare Vorgang zur Prüfung angehalten werden.

Auch Ereignismeldungen vom Anbieter, sogenannte Webhooks, verdienen diesen Blick. Stripe dokumentiert beispielsweise mögliche Mehrfachzustellung und eine nicht garantierte Ereignisreihenfolge. Übernimm daraus keine pauschale Regel für jede API, sondern prüfe die Zustellbedingungen deines Anbieters.

Limits verändern den Ablauf

Eine Schnittstelle kann die Zahl der Anfragen begrenzen. HTTP 429 signalisiert eine solche Begrenzung; eine Antwort kann zusätzlich angeben, wie lange gewartet werden soll. Wiederholungen ohne Pause verschärfen das Problem.

Für größere Datenmengen brauchst du außerdem eine Fortsetzung über mehrere Ergebnisseiten. Dokumentiere, welche Seite oder welcher Stand bereits verarbeitet wurde. Ein Tagesabgleich muss nach einer Unterbrechung weiterlaufen können, ohne alles erneut zu schreiben.

Die Abnahme sollte neben dem Normalfall einen ungültigen Datensatz, einen abgelaufenen Zugang und eine vorübergehend nicht erreichbare API enthalten. Prüfe dabei, ob Fehlermeldungen bei einer zuständigen Person ankommen und ob sie den betroffenen Vorgang ohne unnötige Kundendaten identifizieren kann.

Schnittstelle anbinden setzt eine dokumentierte, vorhandene API voraus. Fehlt die benötigte Operation in deinem eigenen System, ist Eigene API entwickeln eine andere Aufgabe. Für eine neue fachliche Regel innerhalb eines bestehenden Servers gibt es Backend-Funktion entwickeln.