Integrationen
REST API
Token, Bearer-Zugang, Beispielanfrage und Links zur OpenAPI-Referenz.
Dokumentationsabschnitte
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önlicher API-Token benötigt. Die Anfrage erfolgt im Namen des Benutzers, der den Token ausgestellt hat, und durchläuft dieselben Rollen- und Berechtigungsprüfungen.
Authentifizierung
Übergeben Sie den Token im HTTP-Header:
Authorization: Bearer <token>
Wie Sie Token ausstellen, speichern und widerrufen, ist im Artikel API-Token beschrieben.
Beispielanfrage
curl -sS "$TEALBAND_BASE_URL/api/v1/{org}/surveys" \
-H "Accept: application/json" \
-H "Authorization: Bearer $TEALBAND_API_TOKEN"
Ersetzen Sie {org} durch die ID Ihrer Organisation. Die Parameter eines bestimmten Endpunkts, das Antwortformat und die Fehlercodes entnehmen Sie der vollständigen Spezifikation.
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.