API publique
Erreurs
Comprendre les erreurs de l'API publique CycleCore.
Erreurs
L'API publique retourne des codes HTTP standards et un corps JSON lorsque l'erreur peut etre representee proprement.
Format general
{
"statusCode": 401,
"message": "Cle API invalide.",
"error": "Unauthorized"
}Certaines erreurs peuvent ajouter un champ code pour faciliter le traitement
automatique.
{
"statusCode": 429,
"code": "PUBLIC_API_RATE_LIMIT_EXCEEDED",
"message": "Limite de requetes API publique depassee.",
"retryAfter": 60
}Codes principaux
| Code | Signification | Action recommandee |
|---|---|---|
400 | Requete invalide | Verifier les parametres, filtres ou le JSON envoye |
401 | Non authentifie | Verifier l'en-tete Authorization et l'etat de la cle |
403 | Scope insuffisant | Ajouter le scope requis ou utiliser une autre cle |
404 | Ressource introuvable | Verifier que la ressource appartient a l'organisation |
409 | Conflit | Corriger l'identifiant, le SKU ou la donnee deja utilisee |
422 | Regle metier non respectee | Corriger les valeurs selon les attributs et la famille |
429 | Trop de requetes | Attendre retryAfter avant de reessayer |
500 | Erreur serveur | Reessayer plus tard et contacter le support si le probleme persiste |
Authentification
Les erreurs 401 les plus frequentes sont:
- En-tete
Authorizationabsent. - Format different de
Bearer ccpk_xxx. - Cle API invalide.
- Cle API expiree ou revoquee.
Scopes
Une erreur 403 signifie que la cle est reconnue, mais qu'elle ne porte pas le
scope requis pour l'endpoint appele.
Exemple: appeler /public/v1/media sans media:read retourne 403.
Isolation multi-tenant
Une ressource appartenant a une autre organisation ne doit pas etre exposee par
l'API publique. Selon le cas, CycleCore peut retourner 404 plutot que
confirmer l'existence d'une ressource inaccessible.