Limites de débit¶
Spécification du token bucket¶
L'API VoidSign applique une limite de débit de type token bucket de 60 requêtes par minute par clé API. Chaque clé API démarre avec 60 jetons, et un jeton est consommé par requête. Les jetons se rechargent à un rythme constant d'un jeton par seconde.
Cela signifie :
- Vous pouvez envoyer jusqu'à 60 requêtes instantanément en rafale.
- Après avoir épuisé tous les jetons, vous récupérez la capacité d'effectuer une requête par seconde.
- Le bucket ne dépasse jamais 60 jetons.
En-têtes de limite de débit¶
Chaque réponse de l'API inclut les en-têtes suivants conformes au standard IETF :
| En-tête | Description | Exemple |
|---|---|---|
RateLimit-Policy |
La politique de limite de débit en vigueur. | 60;w=60 |
RateLimit-Limit |
Nombre maximum de requêtes par fenêtre. | 60 |
RateLimit-Remaining |
Nombre de requêtes restantes avant limitation. | 57 |
RateLimit-Reset |
Secondes avant qu'au moins un jeton soit disponible. | 0 |
Lorsqu'une requête est rejetée (HTTP 429), la réponse inclut en plus :
| En-tête | Description | Exemple |
|---|---|---|
Retry-After |
Secondes à attendre avant de réessayer. | 1 |
Réponse d'erreur 429¶
Lorsque vous dépassez la limite de débit, l'API retourne HTTP 429 Too Many Requests avec l'enveloppe d'erreur standard :
{
"error": {
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded. Retry after the period indicated in the Retry-After header"
}
}
Exemple d'en-têtes¶
curl -si \
"https://api.voidsign.com/api/v1/requests/YOUR_REQUEST_ID" \
-H "X-VoidSign-Key: vs_live_YOUR_API_KEY"
En-têtes de réponse (requête réussie) :
En-têtes de réponse (limite de débit atteinte) :
HTTP/2 429
RateLimit-Policy: 60;w=60
RateLimit-Limit: 60
RateLimit-Remaining: 0
RateLimit-Reset: 1
Retry-After: 1
Pour la stratégie de retry recommandée et les bonnes pratiques, consultez Appeler l'API VoidSign.