Errori

Gestione errori

L'API utilizza codici di risposta HTTP convenzionali per indicare il successo o il fallimento delle richieste.

Codici di stato HTTP

CodeDescrizione
200Successo - Richiesta completata con successo
400Richiesta errata - Parametri di richiesta non validi
401Non autorizzato - Chiave API non valida o mancante
404Non trovato - La risorsa richiesta non esiste
500Errore interno del server - Si è verificato un errore del server

Formato risposta errore

Tutte le risposte di errore seguono un formato coerente:

Struttura della risposta di errorejson
{
  "success": false,
  "error": "Human-readable error message",
  "code": "ERROR_CODE"
}

Codici di errore

CodeDescrizione
UNAUTHORIZEDChiave API non valida o mancante
INVALID_PARAMSValidazione parametri query fallita
INVALID_IDFormato UUID non valido per ID tariffa
NOT_FOUNDLa tariffa richiesta non esiste
DATABASE_ERRORQuery database fallita
INTERNAL_ERRORErrore server imprevisto

Esempio

401 Unauthorized

Chiave API mancante o non validajson
{
  "success": false,
  "error": "Unauthorized",
  "code": "UNAUTHORIZED"
}

400 Bad Request

Parametri di richiesta non validijson
{
  "success": false,
  "error": "Invalid query parameters",
  "code": "INVALID_PARAMS"
}

404 Not Found

Risorsa non trovatajson
{
  "success": false,
  "error": "Tariff not found",
  "code": "NOT_FOUND"
}

Buone pratiche

  • 1.Controlla sempre il campo success nella risposta per determinare se la richiesta è andata a buon fine
  • 2.Usa il campo code per la gestione programmatica degli errori nella tua applicazione
  • 3.Mostra il messaggio error agli utenti per fornire un riscontro comprensibile
  • 4.Implementa un backoff esponenziale per riprovare le richieste non riuscite, soprattutto per gli errori 5xx
Gestione errori | Strompreise Schweiz