Gestion des erreurs

L'API de Swaloo est construite sur API Platform. Les erreurs sont renvoyées au format Hydra / Problem Details, avec le bon code HTTP et un corps JSON décrivant le problème.

Format général

Une erreur contient généralement un titre, un statut HTTP et un détail. Exemple :

{
  "title": "An error occurred",
  "detail": "Not Found",
  "status": 404
}

Le format exact peut varier selon le type de négociation de contenu (JSON-LD / Hydra ou JSON Problem Details).

Erreurs de validation (422)

Lorsqu'une requête échoue à la validation, l'API répond en 422 Unprocessable Entity avec un tableau violations détaillant les champs en cause :

{
  "status": 422,
  "detail": "recipientAddress: L'adresse est obligatoire.",
  "violations": [
    {
      "propertyPath": "recipientAddress",
      "message": "L'adresse est obligatoire."
    },
    {
      "propertyPath": "weight",
      "message": "Le poids doit être supérieur à 0."
    }
  ]
}

Codes HTTP

Bonnes pratiques

• Vérifiez toujours le code HTTP avant de parser le corps de la réponse.
• Affichez les messages du tableau violations à l'utilisateur pour les erreurs 422.
• Implémentez un retry avec backoff pour les 429 et 5xx.
• Journalisez les erreurs 5xx pour le débogage.

Voir aussi : Endpoints | Limites de débit