Die Befolgung bewährter Integrationspraktiken trägt dazu bei, die Zuverlässigkeit zu verbessern, vermeidbare Fehler zu reduzieren und Support-Untersuchungen bei der Nutzung von DQE-APIs zu beschleunigen.
Die richtige Umgebung verwenden
Stellen Sie sicher, dass jede Integration den richtigen Endpunkt, die richtigen Anmeldedaten, die richtige Lizenz und die richtige Umgebung verwendet. Vermeiden Sie es, Produktionsanmeldedaten mit Test- oder Staging-Umgebungen zu vermischen.
Eingaben vor dem Senden von Anfragen validieren
Bereinigen und formatieren Sie Eingabedaten, bevor Sie DQE-APIs aufrufen. Entfernen Sie unnötige Leerzeichen, versteckte Zeichen, unvollständige Werte und interne Kommentare, die nicht Teil der zu validierenden Daten sind.
API-Antworten explizit behandeln
Gestalten Sie Ihre Integration so, dass erfolgreiche Antworten, abgelehnte Anfragen, Fälle ohne Ergebnis, Zeitüberschreitungen und unerwartete Fehler jeweils separat behandelt werden. Vermeiden Sie es, alle nicht erfolgreichen Antworten als dasselbe Problem zu behandeln.
Sicheres Wiederholungsverhalten implementieren
Verwenden Sie kontrollierte Wiederholungsversuche bei vorübergehenden Fehlern. Vermeiden Sie aggressive Wiederholungsschleifen, insbesondere in Produktions-Workflows, da diese den Datenverkehr erhöhen und die Untersuchung von Vorfällen erschweren können.
Nützlichen technischen Kontext protokollieren
Führen Sie Protokolle, die Zeitstempel der Anfragen, Endpunktnamen, Antwortstatus, Fehlermeldungen und, sofern verfügbar, Korrelationskennungen enthalten. Protokollieren Sie keine Anmeldedaten, Tokens oder sensible personenbezogene Daten im Klartext.
Produktionsverhalten überwachen
Verfolgen Sie Fehlerraten, Antwortzeiten, die Häufigkeit von Zeitüberschreitungen und ungewöhnliche Veränderungen bei den Raten ohne Ergebnis. Die Überwachung hilft, Integrations- oder Datenqualitätsprobleme zu erkennen, bevor sie eine große Anzahl von Nutzern betreffen.
Wann Sie den DQE-Support kontaktieren sollten
Wenn Sie Hilfe bei der Untersuchung eines API-Verhaltens benötigen, geben Sie den aufgerufenen Dienst, die Umgebung, den Endpunkt, den Zeitstempel der Anfrage, Antwortdetails, kürzliche Änderungen und Beispielanfragen ohne sensible Daten an.