Wenn Sie ein Support-Ticket für ein API-Problem erstellen, helfen die richtigen technischen Details dem DQE-Support, das Verhalten zu reproduzieren, den betroffenen Dienst zu identifizieren und schneller zu ermitteln.
Erforderlicher Kontext
- den Namen Ihrer Organisation;
- den betroffenen DQE-Dienst oder die betroffene API;
- die verwendete Umgebung, z. B. Produktion, Staging, Test oder Sandbox;
- den Endpunkt und die HTTP-Methode;
- das Datum und die Uhrzeit der Anfrage, einschließlich Zeitzone;
- die geschäftlichen Auswirkungen des Problems.
Details zu Anfrage und Antwort
Fügen Sie nach Möglichkeit ein vollständiges Beispiel bei. Entfernen oder maskieren Sie sensible Informationen wie Anmeldedaten, Tokens, Lizenzen und personenbezogene Daten, bevor Sie diese in einem Ticket weitergeben.
- Anfrageparameter oder -text;
- verwendete Header, mit maskierten sensiblen Werten;
- Antworttext;
- HTTP-Statuscode, sofern verfügbar;
- von der API zurückgegebene Fehlermeldung;
- Korrelations-ID oder Anfrage-ID, sofern verfügbar.
Erwartetes Verhalten
Erklären Sie, welches Ergebnis Sie erwartet haben und warum. Wenn das Problem Adress-, E-Mail-, Telefon- oder Geocoding-Ergebnisse betrifft, geben Sie das erwartete Validierungs- oder Antwortergebnis an.
Kürzliche Änderungen
Erwähnen Sie alle kürzlichen Änderungen, die sich auf die Integration ausgewirkt haben könnten, wie Deployment, Netzwerk-Update, Änderung der Anmeldedaten, Endpunktänderung, neue Umgebung oder Konfigurationsaktualisierung.
Verwandte Artikel
- So beheben Sie Probleme mit der API-Authentifizierung
- Warum wird meine API-Anfrage abgelehnt?
- Warum liefert die API kein Ergebnis?