Erreurs

Gestion des erreurs

L'API utilise des codes de réponse HTTP conventionnels pour indiquer le succès ou l'échec des requêtes.

Codes de statut HTTP

CodeDescription
200Succès - Requête complétée avec succès
400Requête incorrecte - Paramètres de requête invalides
401Non autorisé - Clé API invalide ou manquante
404Non trouvé - La ressource demandée n'existe pas
500Erreur serveur interne - Une erreur serveur s'est produite

Format de réponse d'erreur

Toutes les réponses d'erreur suivent un format cohérent:

Structure de la réponse d'erreurjson
{
  "success": false,
  "error": "Human-readable error message",
  "code": "ERROR_CODE"
}

Codes d'erreur

CodeDescription
UNAUTHORIZEDClé API invalide ou manquante
INVALID_PARAMSÉchec de validation des paramètres de requête
INVALID_IDFormat UUID invalide pour l'ID du tarif
NOT_FOUNDLe tarif demandé n'existe pas
DATABASE_ERRORÉchec de la requête de base de données
INTERNAL_ERRORErreur serveur inattendue

Exemple

401 Unauthorized

Clé API manquante ou invalidejson
{
  "success": false,
  "error": "Unauthorized",
  "code": "UNAUTHORIZED"
}

400 Bad Request

Paramètres de requête invalidesjson
{
  "success": false,
  "error": "Invalid query parameters",
  "code": "INVALID_PARAMS"
}

404 Not Found

Ressource introuvablejson
{
  "success": false,
  "error": "Tariff not found",
  "code": "NOT_FOUND"
}

Bonnes pratiques

  • 1.Vérifiez toujours le champ success dans la réponse pour déterminer si la requête a réussi
  • 2.Utilisez le champ code pour gérer les erreurs de manière programmatique dans votre application
  • 3.Affichez le message error aux utilisateurs pour leur fournir un retour lisible
  • 4.Mettez en œuvre un backoff exponentiel pour réessayer les requêtes échouées, en particulier pour les erreurs 5xx
Gestion des erreurs | Strompreise Schweiz