Erreur

Forme de la réponse d'erreur

Tous les endpoints renvoient les erreurs dans cette enveloppe unifiée.

{
  "success": false,
  "error": {
    "code":    "INVALID_URL",
    "status":  400,
    "message": "The provided URL is not valid",
    "details": null
  }
}

Champs

• success (boolean) : toujours false en cas d'erreur
• error.code (string) : code d'erreur lisible par machine — voir Codes d'erreur
• error.status (number) : code de statut HTTP (reflète le statut de la réponse ; utile si le statut brut n'est pas accessible)
• error.message (string) : description d'erreur lisible
• error.details (object | null) : contexte structuré de l'erreur — par exemple, erreurs de validation au niveau du champ sous forme { field: message } renvoyées sur INVALID_PARAMETER ; null si non applicable

Type TypeScript

type ErrorResponse = {
  success: false;
  error: {
    code: string;       // machine-readable, e.g. "INVALID_URL"
    status: number;     // HTTP status code
    message: string;    // human-readable
    details: Record<string, unknown> | null;
  };
};

Contrat stable : ces 4 champs error.* sont garantis. Les ajouts futurs resteront rétro-compatibles — les clients peuvent ignorer en toute sécurité les champs inconnus.