Authentifizierung und Ratenbegrenzung

Alle Endpunkte der offenen Plattform werden einheitlich über den API-Schlüssel authentifiziert. Auf dieser Seite werden die drei Möglichkeiten zum Schreiben von Token, Paketratenbeschränkungen und die Semantik von Fehlerantworten klar erläutert.

Drei Methoden zum Schreiben der Authentifizierung

1. Autorisierung: Inhaber (empfohlen)

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

Die standardmäßigste Schreibmethode, die standardmäßig von allen SDKs unterstützt wird. Produktionsumgebung wird bevorzugt.

2.X-API-Key-Header

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

Geeignet für Szenarien, in denen der Proxy einiger geschlossener Netzwerke den Autorisierungsheader nicht weiterleiten kann. Funktional gleichbedeutend mit Bearer.

3. Abfrageparameter ?api_key= (nur in Szenarien, in denen Header nicht geschrieben werden kann)

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

Priorität

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

Versuchen Sie es von oben nach unten und beenden Sie die Analyse, wenn Sie eine nicht leere finden.

Ratenbegrenzung

Für jeden API-Schlüssel gibt es zwei Obergrenzen: „pro Minute“ und „täglich“, die automatisch entsprechend dem Paket des Schlüsseleigentümers angewendet werden. Jeder Schlüssel verfügt über ein unabhängiges Kontingent und wird nicht mit anderen Schlüsseln im selben Konto geteilt.

Paketvergleichstabelle

Fenstersemantik

• Minutenfenster · Verwenden Sie Epochenminuten als Schlüssel, und die Grenze wird jede Minute automatisch zurückgesetzt (nicht das Schiebefenster ab dem ersten Aufruf).
• täglich (Tagesfenster) · Verwenden Sie das UTC-Datum als Schlüssel, das jeden Tag automatisch um 00:00 UTC zurückgesetzt wird

Wenn das Limit erreicht ist

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
}

Der Kunde sollte:

• Lesen Sie den Retry-After-Header (Anzahl der Sekunden), warten Sie die entsprechende Zeitspanne und versuchen Sie es dann erneut
• X-RateLimit-Window Zeigt Ihnen an, welches Fenster erreicht wurde (Minute/Tag)
• Exponentieller Backoff + Jitter; Versuchen Sie es nicht sofort erneut, nachdem Sie 429 erhalten haben

Http-antwortcode