Authentification et limitation de débit

Tous les points de terminaison de la plateforme ouverte sont authentifiés uniformément via la clé API. Cette page explique clairement les trois manières d'écrire les jetons, les limites de débit des packages et la sémantique des réponses d'erreur.

Trois méthodes d'écriture d'authentification

1. Autorisation : Au porteur (recommandé)

curl https://braidrun.com/api/v1/workflows \
  -H "Authorization: Bearer dyk_<id>_<secret>"

La méthode d'écriture la plus standard, prise en charge par tous les SDK par défaut. L'environnement de production est préféré.

2.En-tête X-API-Key

curl https://braidrun.com/api/v1/workflows \
  -H "X-API-Key: dyk_<id>_<secret>"

Convient aux scénarios dans lesquels le proxy de certains réseaux fermés ne peut pas transmettre l'en-tête d'autorisation. Fonctionnellement équivalent à Bearer.

3. Paramètre de requête ?api_key= (uniquement dans les scénarios où l'en-tête ne peut pas être écrit)

https://braidrun.com/api/webhook-trigger/approval/appr-123/approve?api_key=dyk_<id>_<secret>

Priorité

1. Authorization: Bearer dyk_…
2. X-API-Key: dyk_…
3. ?api_key=dyk_…

Essayez de haut en bas et arrêtez l'analyse lorsque vous en trouvez un non vide.

Limitation de débit

Chaque clé API a deux limites supérieures « par minute » et « quotidiennement », qui sont automatiquement appliquées en fonction du package du propriétaire de la clé. Chaque clé dispose d'un quota indépendant et n'est pas partagée avec d'autres clés du même compte.

Tableau comparatif des forfaits

Sémantique des fenêtres

• fenêtre des minutes · Utilisez les minutes d'époque comme clé, et la limite est automatiquement réinitialisée toutes les minutes (pas la fenêtre glissante à partir du premier appel)
• quotidiennement (fenêtre de jour) · Utilisez la date UTC comme clé, réinitialisée automatiquement à 00h00 UTC tous les jours

Quand la limite est atteinte

HTTP/1.1 429 Too Many Requests
Retry-After: 38
X-RateLimit-Limit: 60
X-RateLimit-Window: minute
Content-Type: application/json

{
  "error": "Rate limit exceeded",
  "window": "minute",
  "limit": 60,
  "retryAfterSeconds": 38
}

Le client doit :

• Lisez l'en-tête Retry-After (nombre de secondes), attendez la durée correspondante, puis réessayez.
• X-RateLimit-Window Vous indique quelle fenêtre a été touchée (minute/jour)
• Retard exponentiel + gigue ; ne réessayez pas immédiatement après avoir reçu 429

Code de réponse HTTP