Was bedeutet API?
API, d. h. Anwendungsprogrammierschnittstelle, definiert die Art der Kommunikation zwischen Softwareelementen. Bei der Webintegration beschreibt es verfügbare Vorgänge, Datenformate, Autorisierungs- und Antwortregeln. Dank der API kann die Filiale die Bestellung an das Lagersystem übertragen oder aktuelle Verfügbarkeiten herunterladen. Nicht jede API ist öffentlich, kostenlos oder basiert auf demselben Protokoll. Die Implementierung beginnt mit der Dokumentation eines bestimmten Dienstes und den Berechtigungen für dessen Nutzung.
Datenvertrag
Geben Sie erforderliche Felder, Werttypen, Bezeichnerbedeutungen und die Handhabung leerer Daten an. Ein Preis ohne Währungs- und Steuerinformationen kann trotz korrektem JSON-Format falsch interpretiert werden. Unterscheiden Sie zwischen keinem Wert und Null sowie einem lokalen Datum und einer Zeit mit einer Zone. Überprüfen Sie die Paginierung und Filter, damit Sie nicht nur den ersten Teil des Verzeichnisses herunterladen. Der Vertrag beschreibt die Semantik, nicht nur die technische Struktur der Nachricht.
Authentifizierung und Sicherheit
Der Schlüssel oder Token sollte nur über die erforderlichen Berechtigungen verfügen und auf der entsprechenden Umgebungsseite gespeichert werden. Ein im Browsercode hinterlegtes Geheimnis kann vom Besucher gelesen werden. Legen Sie Rotation, Ablauf und Widerruf des Zugriffs fest. Protokolle sollten keine vollständigen Token oder unnötige Kundendaten enthalten. Die Verbindungsverschlüsselung sichert den Transport, ersetzt jedoch nicht die Kontrolle darüber, wer Vorgänge für eine bestimmte Ressource ausführen kann.
Fehler, Limits und Wiederholungsversuche
Behandeln Sie Anforderungslimits, Dienstunterbrechungen und Zeitüberschreitungen. Wiederholen Sie den Auftragserstellungsvorgang nicht gedankenlos, wenn die erste Antwort verloren geht: Die Speicherung wurde möglicherweise bereits durchgeführt. Ein Idempotenzschlüssel oder eine benutzerdefinierte Deduplizierung helfen, Duplikate zu vermeiden. Verwenden Sie begrenzte Wiederholungsversuche und kontrollierte Abstände, keine Endlosschleife. Unterscheiden Sie zwischen einem Fehler, der eine Datenkorrektur erfordert, und einem vorübergehenden Fehler, der ohne Änderung der Anfrage behoben werden kann.
API und Webhook
Bei der zyklischen Abfrage fragt die Anwendung nach dem aktuellen Status. Ein Webhook ermöglicht es dem Quellsystem, über ein Ereignis zu benachrichtigen, wodurch unnötige Abfragen reduziert werden. Beide Mechanismen können zusammenarbeiten: Eine Benachrichtigung signalisiert eine Änderung und eine API liefert Details und ermöglicht den Statusabgleich. Keine garantiert perfekte Ordnung und Vollständigkeit ohne zusätzliche Regeln. Die Integration sollte in der Lage sein, ausgelassene Daten zu erkennen und sicher zu vervollständigen.
Wie kann die Integration aufrechterhalten werden?
Überwachen Sie Fehler, Verzögerungen und die Übereinstimmung der Datensatzanzahl mit dem erwarteten Ergebnis. Für die API-Versionierung sind möglicherweise clientseitige Änderungen erforderlich. Behalten Sie daher die Ankündigungen der Anbieter und die Einstellungstermine für Funktionen im Auge. Testen Sie auf Fehler- und Teilerfolgsszenarien, nicht nur auf die 200er-Antwort. Eine erfolgreiche Netzwerkverbindung ist kein Beweis für den Abschluss eines Geschäftsprozesses. Die letzte Prüfung ist der ordnungsgemäße Zustand der Daten im Zielsystem und die Fähigkeit, fehlgeschlagene Vorgänge zu erklären.
Beispiel für ein unsicheres Schreibergebnis
Die Anwendung sendet eine Anfrage zum Erstellen einer Bestellung, aber die Verbindung wird vor der Antwort unterbrochen. Dies beweist nicht, dass die Aufzeichnung nicht stattgefunden hat. Bei einem erneuten Versuch ohne Prüfung kann ein zweiter Datensatz erstellt werden. Richten Sie mit dem Lieferanten einen Idempotenz- oder Vorabkontrollmechanismus ein. Unterscheiden Sie einen Vorgang von einem einzelnen Übertragungsversuch und speichern Sie eine sichere Kennung, die es Ihnen ermöglicht, das Ergebnis zu verfolgen, ohne Geheimnisse preiszugeben.
Bewältigen Sie auch Teilerfolge: Die Kundenerstellung kann erfolgreich sein, Bestellungen jedoch möglicherweise nicht. Markieren Sie nicht den gesamten Vorgang als abgeschlossen, nur weil die erste Antwort den Code 200 hatte. Überprüfen Sie beim Lesen eines Verzeichnisses die Paginierung und die Anzahl der Datensätze. Korrektes JSON mit der ersten Datenseite kann trotz des Verlusts des größten Teils des Produkts zuverlässig aussehen. Die Überwachung sollte solche Diskrepanzen erkennen, nicht nur Netzwerkfehler.