Fehler

Afi zeigt mit den üblichen HTTP-Statuscodes an, ob eine API-Anforderung erfolgreich war oder fehlgeschlagen ist. Im Allgemeinen gilt:

• Statuscodes im Bereich 2xx zeigen einen Erfolg an.
• Statuscodes im Bereich 4xx weisen auf einen Fehler im Zusammenhang mit den bereitgestellten Informationen und dem aktuellen Zustand hin (z. B. weil ein erforderlicher Parameter fehlt oder ein ungültiger Wert gesendet wurde).
• Statuscodes im Bereich 5xx zeigen einen Fehler bei den Afi-Diensten an (diese Fehler treten selten auf).

Übersicht der HTTP-Statuscodes:

HTTP-Statuscode	Beschreibung
200 OK	Der Aufruf war erfolgreich.
400 Bad Request	Die Anforderung ist fehlgeschlagen. Häufig fehlt ein erforderlicher Parameter, ein Parameter ist ungültig oder beides trifft zu.
401 Unauthorized	Es wurde kein gültiger API-Schlüssel angegeben.
403 Forbidden	Der API-Schlüssel hat nicht die erforderlichen Berechtigungen für die Anforderung.
404 Not Found	Die angeforderte Ressource ist nicht vorhanden.
429 Too Many Requests	Innerhalb kurzer Zeit sind zu viele Anforderungen bei der API eingegangen. Der Aufrufer sollte vor weiteren Versuchen einen exponentiellen Backoff verwenden.
5xx - Internal Server Error	Bei den Afi-Diensten ist ein Fehler aufgetreten (diese Fehler treten selten auf). Die Anforderung kann mit exponentiellem Backoff wiederholt werden.

Bei den Statuscodes 429 und 5xx können Sie die Anforderung mit exponentiellem Backoff wiederholen.

Damit Sie Fehler untersuchen und in Ihrer Anwendung automatisch behandeln können, enthalten Fehlerantworten einen JSON-codierten Antworttext (Response Body) mit folgenden Angaben:

JSON-Fehlerfeld	Beschreibung
status (integer)	HTTP-Statuscode.
code (string)	Ein Fehlercode in Form einer Zeichenfolge, der den gemeldeten Fehlertyp eindeutig kennzeichnet.
message (string)	Für Menschen verständliche Fehlermeldung.