Zum Inhalt springen
WorkLogx
Menü· Rate Limits

Vorschau: Diese Dokumentation beschreibt die WorkLogx Public API V1. Die Bereitstellung von V1 in der Produktionsumgebung ist noch nicht abgeschlossen.

Rate Limits

Jeder API Client darf bis zu 300 Anfragen pro Minute senden.

  • Das Limit gilt pro API Client, über alle seine Keys.
  • Das Zeitfenster ist gleitend: Gezählt werden die Anfragen der letzten 60 Sekunden.
  • Jede authentifizierte Anfrage zählt, auch wenn sie mit einem Fehler endet. Anfragen, die bereits bei der Authentifizierung scheitern (401, 403 api_client_disabled, 403 public_api_unavailable), zählen nicht.

#Wenn das Limit überschritten ist

Die API antwortet mit 429 Too Many Requests und dem Header Retry-After:

HTTP/1.1 429 Too Many Requests
Content-Type: application/problem+json
Retry-After: 60
{
  "type": "https://api.worklogx.com/problems/rate-limit",
  "title": "Too many requests",
  "status": 429,
  "code": "rate_limit_exceeded",
  "requestId": "b2c4e6f8-0a1b-4c3d-8e5f-7a9b1c3d5e7f"
}

Warten Sie die in Retry-After genannten Sekunden, bevor Sie weitere Anfragen senden. Weitere Rate-Limit-Header sendet die API nicht.

#Aktuelle Umsetzung

Der Zähler wird von jeder API-Serverinstanz im Arbeitsspeicher geführt. Betreibt WorkLogx mehrere Instanzen, können Anfragen auf sie verteilt werden, und das effektive Limit kann über 300 pro Minute liegen. Verlassen Sie sich nicht darauf: Legen Sie Ihre Integration auf 300 Anfragen pro Minute und API Client aus.

#Innerhalb des Limits bleiben

  • Für Listen limit=100 verwenden.
  • Für Abgleiche updatedAfter statt Vollexporten nutzen.
  • Batch-Jobs zeitlich verteilen statt in Spitzen zu senden.