Fehler
HTTP-Statuscodes
Abschnitt betitelt „HTTP-Statuscodes“Unsere API verwendet übliche HTTP-Response-Codes, um Erfolg oder Fehlschlag einer API-Anfrage anzuzeigen. Allgemein gilt:
- Codes im Bereich 2xx bedeuten Erfolg
- Codes im Bereich 4xx bedeuten einen Fehler aufgrund der gelieferten Anfrageinformationen (z. B. fehlender Pflichtparameter, fehlerhafte Anfrage, etc.)
- Codes im Bereich 5xx bedeuten einen Fehler auf unseren Servern (selten)
Bei einigen 4xx-Fehlern, die sich programmatisch behandeln lassen, wird ein Fehlercode mitgeliefert, der den Fehler kurz beschreibt.
Statuscode-Referenz
Abschnitt betitelt „Statuscode-Referenz“| Code | Status | Beschreibung |
|---|---|---|
| 200 | OK | Alles hat wie erwartet funktioniert |
| 400 | Bad Request | Die Anfrage ist unzulässig, häufig wegen eines fehlenden Pflichtparameters |
| 401 | Unauthorized | Kein gültiger API-Schlüssel angegeben |
| 402 | Request Failed | Die Parameter waren gültig, aber die Anfrage ist fehlgeschlagen |
| 403 | Forbidden | Der API-Schlüssel hat keine Berechtigung für diese Anfrage |
| 404 | Not Found | Die angeforderte Ressource existiert nicht |
| 429 | Too Many Requests | Zu viele Requests in zu kurzer Zeit. Wir empfehlen exponentielles Backoff beim Retry |
| 500, 502, 503, 504 | Server Errors | Auf unserer Seite ist etwas schiefgelaufen |
Attributes
Abschnitt betitelt „Attributes“| Attribut | Typ | Beschreibung |
|---|---|---|
code |
nullable string | Für einige programmatisch behandelbare Fehler: kurzer String mit dem gemeldeten Fehlercode. |
message |
nullable string | Menschenlesbare Nachricht mit Details zum Fehler. |
details |
nullable object | Zusätzliche Informationen zum Fehler, z. B. welche Parameter ihn ausgelöst haben. |