Format de reponse d’erreur
Champs d’erreur
Types d’erreur
Request ID
Chaque reponse inclut unrequest_id (format : req_ + 12 caracteres alphanumeriques). Vous pouvez egalement envoyer le votre via le header X-Request-Id — l’API l’utilisera au lieu d’en generer un.
Erreurs de validation
Lorsque plusieurs champs echouent a la validation, le tableauerrors liste chacun d’entre eux :
Format des numeros de telephone
Tous les numeros de telephone doivent etre au format E.164 :+ suivi du code pays et du numero, sans espaces ni tirets.
Idempotence
Tous les endpoints d’ecriture (POST, PUT, DELETE) supportent un header optionnelIdempotency-Key pour reessayer les requetes en toute securite.
Comment ca fonctionne
- Envoyez un header
Idempotency-Keyunique avec votre requete d’ecriture (par exemple, un UUID) - Si la requete reussit (2xx), la reponse est stockee pendant 1 heure
- Si vous envoyez la meme cle au meme endpoint, l’API retourne la reponse stockee avec un header
Idempotency-Replayed: true— l’operation n’est pas re-executee - Si la requete echoue (4xx/5xx), la cle n’est pas consommee — vous pouvez reessayer avec la meme cle jusqu’a ce que la requete reussisse
Exemple
Reutilisation des cles entre endpoints
Utiliser la meme cle d’idempotence pour un endpoint ou une methode HTTP differente retourne une erreur409 avec le code IDEMPOTENCY_KEY_REUSE.