Entwicklerdokumentation

Entwickler- API Referenz

Erstellen Sie individuelle Integrationen mit unserer REST-API. Verwalten Sie Umfragen, erfassen Sie Antworten, lösen Sie Kampagnen aus und greifen Sie programmgesteuert auf Analysen zu.

Schnellstart

In wenigen Minuten loslegen

Schnellstart

# Basis-URL

https://api.claform.com/api/v1

# Authentifizierung: Bearer-Token im Header

curl -H "Authorization: Bearer your_api_key" \

https://api.claform.com/api/v1/surveys

# Antwortformat: JSON

{

"data": [...],

"meta": { "total": 42, "page": 1 }

}

Authentifizierung

Sicherer Zugriff

API-Schlüssel

API-Schlüssel mit eingeschränktem Geltungsbereich und Berechtigungen pro Endpunkt. Übergeben Sie sie über den Header Authorization: Bearer .

JWT-Tokens

OAuth-2.0-Bearer-Tokens für Anfragen im Benutzerkontext. Übergeben Sie sie über den Header Authorization .

Ratenbegrenzung

Standardmäßig 60 Anfragen pro Minute. Höhere Limits bei den Tarifen Business (300/Min.) und Enterprise (individuell).

Endpunkte

Zentrale API-Endpunkte

Alle Endpunkte verwenden die Basis-URL /api/v1 und geben JSON-Antworten zurück.

Umfragen

GET/surveys
POST/surveys
GET/surveys/:id
PATCH/surveys/:id
DELETE/surveys/:id
GET/surveys/:id/responses

Antworten

GET/responses
POST/responses
GET/responses/:id
DELETE/responses/:id

Kampagnen

POST/email-campaigns
POST/sms-campaigns
POST/whatsapp-campaigns
POST/voice-distribution
GET/email-campaigns/:id

Analysen

GET/analytics/survey/:id/stats
GET/analytics/survey/:id/trends
POST/analytics/ai/sentiment
POST/analytics/ai/summary

Zielgruppen

GET/audiences
POST/audiences
POST/audiences/:id/contacts
GET/audiences/:id/contacts

Webhooks

POST/webhooks
GET/webhooks
DELETE/webhooks/:id
POST/webhooks/:id/test

SDKs

Offizielle SDKs für 4 Plattformen

Produktionsreife SDKs mit Offline-Unterstützung, Typsicherheit und umfassender Dokumentation.

TypeScript / Node.js
npm install @claform/sdk-core
React Native
npm install @claform/sdk-react-native
Flutter / Dart
flutter pub add claform_sdk_flutter
iOS / Swift
.package(url: "https://github.com/claform/sdk-ios")
Android / Kotlin
implementation "com.claform:sdk-android:1.0.0"

Webhooks

16 Webhook-Ereignistypen

Abonnieren Sie Ereignisse und erhalten Sie HTTP-Callbacks in Echtzeit, wenn in Ihrem Konto Aktionen auftreten.

survey.created
survey.published
survey.closed
survey.deleted
response.started
response.completed
response.updated
response.deleted
campaign.sent
campaign.delivered
campaign.failed
campaign.bounced
contact.created
contact.opted_out
analytics.report_ready
webhook.test

Fehlerbehandlung

Fehlercodes

CodeNameBeschreibung
400Ungültige AnfrageUngültige Anfrageparameter oder ungültiger Anfragetext
401Nicht autorisiertFehlender oder ungültiger API-Schlüssel
403VerbotenUnzureichende Berechtigungen für diese Ressource
404Nicht gefundenDie Ressource existiert nicht
409KonfliktKonflikt im Ressourcenzustand (z. B. Duplikat)
422Nicht verarbeitbarValidierungsfehler im Anfragetext
429Zu viele AnfragenRatenlimit überschritten
500ServerfehlerUnerwarteter Serverfehler

Starten Sie noch heute mit der Entwicklung

Erstellen Sie Ihr Konto und generieren Sie in Sekunden einen API-Schlüssel. Voller API-Zugriff ist in allen Tarifen verfügbar, einschließlich des kostenlosen Tarifs.

API-Schlüssel erhaltenEntwicklerressourcen