Aller au contenu

Erreurs et limites de l'API de la plateforme

Les erreurs de l’API de la plateforme utilisent un format de corps différent de celui des endpoints de modèles : le statut HTTP porte le résultat, et le corps JSON contient toujours success et, en cas d’échec, un code lisible par machine.

En cas de succès, HTTP 200 est retourné :

{
"success": true,
"message": "",
"data": {}
}

En cas d’échec, le vrai code de statut HTTP est utilisé et le corps contient un code lisible par machine :

{
"success": false,
"message": "Invalid Management Key",
"code": "invalid_token"
}

message est localisé et peut changer d’une version à l’autre. Utilisez le code de statut HTTP et code dans la logique de votre programme.

HTTPcodeScénario
400invalid_requestParamètres invalides : montant hors limites, nom manquant ou trop long à la création, status différent de 1 / 2, activation d’une Key encore expirée ou épuisée, date d’expiration invalide, pagination ou plage temporelle invalide, ou ; non encodé dans la query
401invalid_tokenEn-tête Authorization manquant, clé mal formée, ou clé introuvable ou supprimée
401token_expiredLa clé de gestion a expiré
401token_revokedLa clé de gestion a été révoquée (clés existantes uniquement ; les nouvelles clés ne peuvent être que supprimées)
403user_disabledLe compte du propriétaire de la clé de gestion est désactivé
403insufficient_scopeLa clé de gestion ne dispose pas de la permission requise par cet endpoint
404not_foundLa clé API n’existe pas ou ne vous appartient pas (sans distinction), ou le chemin n’existe pas sous /api/open/v1
405method_not_allowedLe chemin existe mais ne prend pas en charge cette méthode HTTP
429rate_limitedLimite de débit par clé de gestion dépassée
500internal_errorErreur serveur ; les détails internes ne sont pas retournés

Les chemins inconnus sous /api/open/v1 retournent 404 et une méthode HTTP incorrecte retourne 405, avec le corps d’erreur unifié ci-dessus ; code permet de distinguer « réessayer avec une autre méthode » de « chemin ou paramètres incorrects ».

PortéeLimiteS’applique àRéponse en cas de dépassement
Par clé de gestion120 requêtes/minuteTous les endpoints de l’API de la plateforme429, avec code à rate_limited
Par utilisateur30 requêtes/minute (par défaut)Logs du compte, Exporter les logs, Usage, Usage par modèle, Usage par Key429 ; le corps de la réponse peut être vide
Par IP client180 requêtes/180 secondes (par défaut)Partagée par tous les endpoints /api429
Par IP client100 requêtes/20 minutes (par défaut)Endpoints sensibles comme Révéler une API Key429 ; le corps de la réponse peut être vide

Traitez la limitation de débit selon le code de statut HTTP. Lorsque vous recevez 429, ralentissez et réessayez plus tard.

Les endpoints de modèles utilisent un autre format d’erreur et des limites distinctes ; voir Erreurs courantes.