Codes d'état de l'API

Cette page décrit comment Metronome utilise les codes d’état HTTP pour indiquer si une requête API a réussi ou échoué. Elle vous aide à interpréter et à gérer les différents types d’erreurs. Metronome utilise des codes d’état HTTP standard :

2xx indique un succès
4xx indique une erreur côté client (par exemple, un paramètre obligatoire a été omis)
5xx indique une erreur côté serveur de Metronome

Chaque erreur 4XX utilise ce format application/json :

{
  "message": "Descriptive error text"
}

Le tableau liste les codes d’état HTTP les plus courants renvoyés par l’API Metronome, ainsi qu’une solution possible.

Code	Signification	Description	Solution possible
200	OK	Tout a fonctionné comme prévu	N/A — la requête a réussi
400	Bad Request	La requête n’était pas acceptable, souvent en raison d’une syntaxe mal formée, ou d’un paramètre manquant ou mal formé	Vérifiez que la syntaxe de la requête est correcte
401	Invalid access token	Le demandeur n’est pas autorisé ou n’a pas la permission pour cet appel d’API	Vérifiez que le jeton d’API est valide
403	Forbidden	Le demandeur n’a pas accès à cette ressource	Vérifiez que le jeton d’API est valide
404	Resource not found	La ressource demandée n’existe pas	Vérifiez que l’ID de la ressource demandée est valide
409	Conflict	La requête n’a pas pu être traitée en raison d’un conflit avec l’état actuel d’une ressource existante	Vérifiez que l’objet n’existe pas déjà, et si vous utilisez un en-tête Idempotency-Key, vérifiez qu’il est unique
429	Too Many Requests	Trop de requêtes ont atteint l’API trop rapidement	Consultez l’en-tête `X-Metronome-Rate-Limit-Type` pour déterminer la portée de la limite (voir ci-dessous), puis effectuez un backoff et réessayez plus tard
5XX	Server Errors	Quelque chose s’est mal passé lors du traitement de votre requête	Réessayez votre requête. Si vous utilisez l’en-tête Idempotency-Key, vérifiez que la ressource n’a pas été partiellement créée et réessayez avec une clé différente

En-têtes de limite de débit

Lorsqu’une requête est limitée en débit (HTTP 429), la réponse inclut un en-tête X-Metronome-Rate-Limit-Type indiquant quelle limite a été dépassée :

Valeur de l’en-tête	Signification
`client`	La limite de débit globale de votre organisation pour ce point de terminaison a été dépassée
`customer`	La limite de débit par client pour le client ciblé a été dépassée

​En-têtes de limite de débit

En-têtes de limite de débit