Zum Inhalt

Fehler

Afi verwendet die üblichen HTTP-Statuscodes, um Erfolg oder Fehlschlag einer API-Anfrage anzugeben. Im Allgemeinen gilt:

  • Statuscodes im Bereich 2xx zeigen einen Erfolg an.
  • Statuscodes im Bereich 4xx zeigen einen Fehler aufgrund der bereitgestellten Informationen und des aktuellen Zustands an (z. B. wurde ein erforderlicher Parameter ausgelassen, ein ungültiger Wert gesendet usw.).
  • Statuscodes im Bereich 5xx zeigen einen Fehler in den Afi-Diensten an (diese Fehler treten selten auf).

Übersicht der HTTP-Statuscodes:

HTTP-StatuscodeBeschreibung
200 OKDer Aufruf war erfolgreich.
400 Bad RequestDie Anfrage ist fehlgeschlagen, häufig aufgrund eines fehlenden erforderlichen Parameters, eines ungültigen Parameters oder einer Kombination aus beidem.
401 UnauthorizedEs wurde kein gültiger API-Schlüssel angegeben.
403 ForbiddenDer API-Schlüssel besitzt nicht die erforderlichen Berechtigungen für die Anfrage.
404 Not FoundDie angeforderte Ressource ist nicht vorhanden.
429 Too Many RequestsZu viele Anfragen haben die API in zu kurzer Zeit erreicht. Der Aufrufer sollte für seine Anfragen einen exponentiellen Backoff verwenden.
5xx - Internal Server ErrorAufseiten von Afi ist ein Fehler aufgetreten (diese Fehler treten selten auf). Die Anfrage kann mit exponentiellem Backoff wiederholt werden.

Beachten Sie, dass Anfragen bei den Statuscodes 429 und 5xx mit exponentiellem Backoff wiederholt werden können.

Zur Unterstützung der Fehlerbehebung und der automatischen Fehlerbehandlung in der Anwendungslogik enthalten Fehler einen JSON-Body mit den folgenden Angaben:

JSON-FehlerfeldBeschreibung
status (Ganzzahl)HTTP-Statuscode.
code (Zeichenfolge)Eine Zeichenfolge, die den gemeldeten Fehlertyp eindeutig kennzeichnet.
message (Zeichenfolge)Für Menschen verständliche Fehlermeldung.