Besonderheiten
Cloud Gateway hat einige Besonderheiten in die Requests & die Responses eingebaut, die einem Entwickler die Diagnose von Problemen erleichtern soll.
Fehlercodes & Fehlermeldungen
502 Bad Gateway
Ein HTTP 502 Fehler tritt auf, wenn das DATEV System gerade nicht online oder nicht mit Cloud Gateway verbunden ist. In diesem Fall kann die Anfrage nicht verarbeitet werden.
JSON-Fehlermeldungen mit rieckenErrorId
Falls ein Fehler von Cloud Gateway selbst ausgelöst wird, enthält die API-Response ein JSON-Fehlerobjekt mit einer eindeutigen rieckenErrorId
. Diese ID kann für Diagnosezwecke genutzt werden, um Fehler schneller zu analysieren.
Beispiel:
{
"error": "Unauthorized",
"message": "Invalid credentials provided.",
"rieckenErrorId": "abc123xyz"
}
Cloud Gateway Response-Header
Zusätzlich zu den regulären HTTP-Headern liefert Cloud Gateway einige eigene x-riecken-response Header, die diagnostische Informationen enthalten:
Verdächtige unautorisierte Anfragen
Diese Header helfen bei der Identifikation von mehrfachen fehlgeschlagenen Authentifizierungsversuchen:
x-riecken-suspicous-unauthorized-attempts
→ Anzahl fehlgeschlagener Zugriffsversuche.x-riecken-suspicous-unauthorized-caller-id
→ Identifikation des Clients, der die Versuche durchgeführt hat.x-riecken-suspicous-unauthorized-last-try
→ Zeitpunkt des letzten fehlgeschlagenen Versuchs.x-riecken-suspicous-unauthorized-lockout-until
→ Zeitpunkt, bis zu dem weitere Versuche blockiert sind.
Fehlgeschlagene Authentifizierungsversuche mit ungültigem Header
Falls ein ungültiger Authorization-Header verwendet wurde, sind folgende Header relevant:
x-riecken-suspicous-invalid-auth-header-attempts
→ Anzahl der Versuche mit fehlerhaftem Auth-Header.x-riecken-suspicous-invalid-auth-header-caller-id
→ Identifikation des Clients.x-riecken-suspicous-invalid-auth-header-last-try
→ Zeitpunkt des letzten Fehlversuchs.x-riecken-suspicous-invalid-auth-header-lockout-until
→ Zeitpunkt, bis zu dem weitere Versuche blockiert sind.
Requester-Informationen
Diese Header enthalten Details zur Ursprungs-IP der Anfrage:
x-riecken-origin
→ Ursprungs-IP der Anfrage.x-riecken-requester-ip-address
→ IP-Adresse des Anfragenden.x-riecken-requester-ip-address-isp
→ Identifikation des ISPs (falls verfügbar).x-riecken-requester-ip-address-continent-code
→ Kontinent der IP-Adresse.
Gefilterte Antworten
Falls Cloud Gateway eine Response in irgendeiner Weise modifiziert oder bereinigt hat:
x-riecken-filtered
→ Gibt an, ob eine Filterung erfolgt ist (true/false
).x-riecken-filtered-length
→ Gibt die Länge der bereinigten Antwort an.
Cloud Gateway kann gewisse Responses filtern.
Beispiel:
GET /datev/api/accounting/v1/clients
Wenn die Berechtigungen im DATEV System auf gewisse Ordnungsbegriffe eingeschränkt sind, filtert Cloud Gateway die vom DATEV System kommende Response der Client-list auf die freigegebenen Clients.
Fehlermeldungen vom DATEV System
Falls ein Fehler direkt von DATEV kommt und nicht von Cloud Gateway generiert wurde, enthält die Antwort den folgenden Header:
x-riecken-bad-response-exception = 1
→ Ein Fehler wurde von DATEV zurückgegeben, nicht von Cloud Gateway.