Erreurs API

Contrat d’erreur stable, corrélable et exploitable par les clients.

Shape recommandé

{
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "Ce client ne peut pas lire cet Espace.",
    "request_id": "req_...",
    "details": {}
  }
}

Codes

Les clients doivent pouvoir réagir à un code stable, pas parser le texte humain.

Catégories :

authentification ;
permission ;
validation ;
conflit ;
capacité ;
quota provider ;
ressource absente ;
indisponibilité temporaire ;
erreur interne.

Sécurité

Ne pas exposer stack traces, credentials, requêtes SQL ou contenu mémoire sensible dans une erreur publique.

Was this page helpful?