GlossarAPI
Eine API definiert eine strukturierte Methode zum Datenaustausch oder zur Anforderung von Operationen zwischen Systemen. In einem Programm kann sie Käufe, Teilnahmeberechtigungen, Punkte oder Bestellungen verknüpfen. Vertrag, Authentifizierung, Fehler, Limits und Nachbearbeitung müssen dokumentiert werden, um die Integration nutzbar zu machen.
Ein konkretes Beispiel
Eine API kann eine validierte Bestellung empfangen und deren Verarbeitungs-ID zurückgeben. Eine eindeutige ID verhindert, dass dieselbe Transaktion zweimal gutgeschrieben wird.
Ein wichtiger Punkt
Die bloße Abdeckung des Nominalfalls ist unzureichend. Dokumentauthentifizierung, Duplikate, Fehler, Wiederholungsversuche und Häufigkeitsbegrenzungen sind erforderlich.
Erstellen Sie einen Vertrag, der von beiden Teams genutzt werden kann.
Geben Sie für jeden Austausch ein akzeptiertes und ein abgelehntes Beispiel, die erforderlichen Felder und die Wiederaufnahmeregeln an. Definieren Sie eine Korrelationskennung, um eine Transaktion zwischen Systemen nachzuverfolgen. Testen Sie eine Unterbrechung nach der Verarbeitung, aber vor dem Empfang der Antwort: Die Wiederaufnahme muss das Ergebnis liefern, ohne eine zweite Gutschrift zu erzeugen. Planen Sie außerdem die Nachverfolgung von Ablehnungen und die Sicherstellung der Versionskompatibilität ein.
Fragen an Ihr Team
- Können wir feststellen, ob eine Transaktion nach einem Ausfall verarbeitet wurde?
- Werden temporäre Fehler und ungültige Daten unterschiedlich behandelt?
Erweitern Sie Ihr Netzwerk.
Whitepaper