REST API

Die REST-API ist unter /api/v1 verfügbar und eignet sich für Skripte, interne Dienste, CI, Datenexporte und andere serverseitige Automatisierung.

Für geschützte Endpunkte wird ein persönliches API-Token benötigt. Die Anfrage wird im Namen des Benutzers ausgeführt, der das Token ausgestellt hat, und durchläuft dieselben Rollen- und Berechtigungsprüfungen.

Autorisierung

Übergeben Sie das Token im HTTP-Header:

Authorization: Bearer <token>

Wie Sie Tokens ausstellen, speichern und widerrufen, ist im Artikel API-Tokens beschrieben.

Beispielanfrage

curl -sS "$PLATFORM_BASE_URL/api/v1/{org}/surveys" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $PLATFORM_API_TOKEN"

Ersetzen Sie {org} durch die ID der Organisation. Die Parameter des jeweiligen Endpunkts, das Antwortformat und die Fehlercodes finden Sie in der vollständigen Spezifikation.

Anfragelimits

Die API ist durch eine Ratenbegrenzung vor Überlastung geschützt:

• Autorisierte API der Anwendung: 300 Anfragen pro Minute je Benutzer oder IP-Adresse.
• Webhook des Zahlungsanbieters: 600 Anfragen pro Minute.
• Öffentliche Endpunkte (/status, Wissensdatenbank-Karten): 300 Anfragen pro Minute je IP-Adresse.

Bei Überschreitung des Limits antwortet der Server mit HTTP 429 Too Many Requests, dem Header Retry-After (Anzahl der Sekunden bis zum nächsten Versuch) und einem Fehler-Body:

{
  "status": 429,
  "message": "Zu viele Anfragen. Versuchen Sie es in 30 Sekunden erneut.",
  "errors": {}
}

Vollständige Dokumentation

• OpenAPI-Referenz – interaktive Dokumentation zu Endpunkten, Parametern und Antwortschemata.
• OpenAPI-JSON – maschinenlesbares Schema für Client-Generatoren, Postman, Insomnia und Vertragsprüfungen.