Fehler

Fehlerbehandlung

Die API verwendet konventionelle HTTP-Antwortcodes, um den Erfolg oder Misserfolg von Anfragen anzuzeigen.

HTTP-Statuscodes

CodeBeschreibung
200Erfolg - Anfrage erfolgreich abgeschlossen
400Ungültige Anfrage - Ungültige Anfrageparameter
401Nicht autorisiert - Ungültiger oder fehlender API-Schlüssel
404Nicht gefunden - Angeforderte Ressource existiert nicht
500Interner Serverfehler - Serverfehler aufgetreten

Fehlerantwortformat

Alle Fehlerantworten folgen einem einheitlichen Format:

Fehlerantwortstrukturjson
{
  "success": false,
  "error": "Human-readable error message",
  "code": "ERROR_CODE"
}

Fehlercodes

CodeBeschreibung
UNAUTHORIZEDUngültiger oder fehlender API-Schlüssel
INVALID_PARAMSValidierung der Abfrageparameter fehlgeschlagen
INVALID_IDUngültiges UUID-Format für Tarif-ID
NOT_FOUNDAngeforderter Tarif existiert nicht
DATABASE_ERRORDatenbankabfrage fehlgeschlagen
INTERNAL_ERRORUnerwarteter 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
Fehlerbehandlung | Strompreise Schweiz