Fehler
Fehlerbehandlung
Die API verwendet konventionelle HTTP-Antwortcodes, um den Erfolg oder Misserfolg von Anfragen anzuzeigen.
HTTP-Statuscodes
| Code | Beschreibung |
|---|---|
200 | Erfolg - Anfrage erfolgreich abgeschlossen |
400 | Ungültige Anfrage - Ungültige Anfrageparameter |
401 | Nicht autorisiert - Ungültiger oder fehlender API-Schlüssel |
404 | Nicht gefunden - Angeforderte Ressource existiert nicht |
500 | Interner Serverfehler - Serverfehler aufgetreten |
Fehlerantwortformat
Alle Fehlerantworten folgen einem einheitlichen Format:
Fehlerantwortstrukturjson
{
"success": false,
"error": "Human-readable error message",
"code": "ERROR_CODE"
}Fehlercodes
| Code | Beschreibung |
|---|---|
UNAUTHORIZED | Ungültiger oder fehlender API-Schlüssel |
INVALID_PARAMS | Validierung der Abfrageparameter fehlgeschlagen |
INVALID_ID | Ungültiges UUID-Format für Tarif-ID |
NOT_FOUND | Angeforderter Tarif existiert nicht |
DATABASE_ERROR | Datenbankabfrage fehlgeschlagen |
INTERNAL_ERROR | Unerwarteter Serverfehler |
Beispiel
401 Unauthorized
Fehlender oder ungültiger API-Schlüsseljson
{
"success": false,
"error": "Unauthorized",
"code": "UNAUTHORIZED"
}400 Bad Request
Ungültige Anfrageparameterjson
{
"success": false,
"error": "Invalid query parameters",
"code": "INVALID_PARAMS"
}404 Not Found
Ressource nicht gefundenjson
{
"success": false,
"error": "Tariff not found",
"code": "NOT_FOUND"
}Bewährte Vorgehensweisen
- 1.Prüfen Sie immer das
success-Feld in der Antwort, um festzustellen, ob die Anfrage erfolgreich war - 2.Verwenden Sie das
code-Feld für die programmgesteuerte Fehlerbehandlung in Ihrer Anwendung - 3.Zeigen Sie den
error-Text für den Nutzer an, um eine verständliche Rückmeldung zu geben - 4.Implementieren Sie bei fehlgeschlagenen Anfragen einen exponentiellen Backoff, insbesondere bei 5xx-Fehlern