Entwicklerressourcen

Entwickelt für Entwickler, von Entwicklern

Eine leistungsstarke REST-API, 4 native SDKs auf Basis eines gemeinsamen TypeScript Core, Echtzeit-Webhooks und über 80 Integrationen. Alles, was Sie benötigen, um Umfragen in jede Anwendung oder jeden Workflow einzubetten.

Schnellstart
curl -X GET https://api.claform.com/api/v1/surveys \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

REST-API

Eine umfassende REST-API

Eine vollständig dokumentierte RESTful-API mit vorhersehbaren, ressourcenorientierten URLs, JSON-Anfrage-/Antwortkörpern und standardmäßigen HTTP-Methoden.

API-Grundlagen

Basis-URLhttps://api.claform.com/api/v1

Allen Endpunkten ist die versionierte Basis-URL vorangestellt

AuthentifizierungAuthorization: Bearer

Generieren Sie API-Schlüssel über Ihr Dashboard oder verwenden Sie JWT für nutzerbezogenen Zugriff

Ratenbegrenzung60 Anfragen/Minute

Standardmäßige Ratenbegrenzung pro Schlüssel, mit höheren Stufen verfügbar; Header zeigen das verbleibende Kontingent an

FormatJSON (application/json)

Alle Anfragen und Antworten verwenden die JSON-Kodierung mit UTF-8

VerschlüsselungTLS 1.3 erforderlich

Der gesamte API-Verkehr wird durchgängig über HTTPS verschlüsselt

Authentifizierungsbeispiel

// Using API Key (recommended for server-to-server)
const headers = {
  'Authorization': 'Bearer sk_live_your_api_key',
  'Content-Type': 'application/json',
};

// Using JWT (for user-scoped access)
const { token } = await fetch('/api/v1/auth/login', {
  method: 'POST',
  body: JSON.stringify({ email, password }),
}).then(r => r.json());

Wichtige Endpunkte

GET
/api/v1/surveys

Listet alle Umfragen mit Paginierung, Filterung und Sortierung auf

POST
/api/v1/surveys

Erstellt eine neue Umfrage mit Fragen, Logik und Einstellungen

GET
/api/v1/surveys/:id/responses

Ruft Umfrageantworten mit erweiterter Filterung ab

POST
/api/v1/email-campaigns

Startet E-Mail-Verteilungskampagnen an Zielgruppenlisten

GET
/api/v1/analytics/surveys/:id

Ruft Analysen mit Diagrammen, Trends und KI-Erkenntnissen ab

POST
/api/v1/webhooks

Registriert Webhook-Endpunkte für Echtzeit-Ereignisse

Über 75 Endpunkte für Umfragen, Fragen, Antworten, Kampagnen, Analysen, Zielgruppen, Kontakte, Integrationen, Webhooks und Administration. Vollständige Paginierung, Filterung und Sortierung bei allen Listen-Endpunkten.

Native SDKs

4 native SDKs auf einem gemeinsamen Core

Betten Sie Umfragen nativ in jede Anwendung ein. Vier native SDKs basieren auf einer gemeinsamen TypeScript-Core-Engine, jedes mit allen über 35 Fragetypen, Offline-Unterstützung, Themes, Barrierefreiheit und Echtzeit-Ereignisverarbeitung.

TypeScript Core

Web und Node.js · ~27 KB komprimiert

npm install @claform/sdk-core
  • Reines TypeScript, ohne Abhängigkeiten
  • Über 35 Fragetypen
  • Offline-Unterstützung
  • Ereignisgesteuerte Architektur
TypeScript Core-Beispiel
import { SurveySDK } from '@claform/sdk-core';

const sdk = new SurveySDK({
  apiKey: 'your-api-key',
  baseUrl: 'https://api.claform.com/api/v1',
});

const survey = await sdk.loadSurvey('survey-id');
const response = await sdk.submitResponse(answers);

React Native

iOS und Android · 262 KB + Core

npm install @claform/sdk-react-native
  • Native UI-Komponenten
  • 12 benutzerdefinierte Hooks
  • Offline-Warteschlange
  • Unterstützung der Barrierefreiheit
React Native-Beispiel
import { SurveyProvider, SurveyView } from '@claform/sdk-react-native';

function App() {
  return (
    <SurveyProvider apiKey="your-api-key">
      <SurveyView
        surveyId="survey-id"
        onComplete={(response) => console.log(response)}
      />
    </SurveyProvider>
  );
}

Flutter

iOS und Android · Reines Dart

flutter pub add claform_sdk_flutter
  • Material-3-Themes
  • Zustandsverwaltung mit Provider
  • Offline-Synchronisierung
  • Über 35 Frage-Widgets
Flutter-Beispiel
import 'package:claform_sdk_flutter/claform_sdk_flutter.dart';

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return SurveyProvider(
      apiKey: 'your-api-key',
      child: SurveyScreen(surveyId: 'survey-id'),
    );
  }
}

iOS (Swift)

iOS 15+ · Keine externen Abhängigkeiten

.package(url: "https://github.com/claform/sdk-ios")
  • Native SwiftUI-Ansichten
  • SPM und CocoaPods
  • UIKit-Brücke
  • Unterstützung für Dynamic Type
iOS (Swift)-Beispiel
import ClaformSDK

struct ContentView: View {
    var body: some View {
        SurveyView(
            apiKey: "your-api-key",
            surveyId: "survey-id"
        ) { response in
            print("Completed: \(response)")
        }
    }
}

Android (Kotlin)

API 24+ · Jetpack Compose

implementation("com.claform:sdk-android:1.0.0")
  • UI mit Compose
  • Material3-Theme
  • Gradle-Versionskatalog
  • Coroutines und Flow
Android (Kotlin)-Beispiel
import com.claform.sdk.SurveyScreen
import com.claform.sdk.SurveyViewModel

@Composable
fun SurveyPage(viewModel: SurveyViewModel = viewModel()) {
    SurveyScreen(
        apiKey = "your-api-key",
        surveyId = "survey-id",
        onComplete = { response -> /* handle */ }
    )
}

Webhooks

Echtzeit-Ereignisbenachrichtigungen

Abonnieren Sie Ereignisse und erhalten Sie sofortige HTTP-Rückrufe, wenn in Ihrem Konto etwas geschieht. Kein Polling erforderlich.

Unterstützte Ereignisse

response.created

Wird ausgelöst, wenn eine neue Umfrageantwort übermittelt wird

response.updated

Wird ausgelöst, wenn eine Teilantwort aktualisiert oder abgeschlossen wird

survey.published

Wird ausgelöst, wenn eine Umfrage veröffentlicht wird und live geht

survey.closed

Wird ausgelöst, wenn eine Umfrage für neue Antworten geschlossen wird

campaign.sent

Wird ausgelöst, wenn eine Verteilungskampagne gestartet wird

campaign.delivered

Wird ausgelöst, wenn Kampagnennachrichten zugestellt werden

campaign.bounced

Wird ausgelöst, wenn Kampagnennachrichten zurückkommen (Bounce)

contact.opted_out

Wird ausgelöst, wenn sich ein Kontakt abmeldet oder austrägt

Webhook-Funktionen

  • Signaturprüfung

    Jede Webhook-Nutzlast wird mit HMAC-SHA256 und Ihrem geheimen Schlüssel signiert, um eine manipulationssichere Zustellung zu gewährleisten.

  • Automatische Wiederholungen

    Fehlgeschlagene Zustellungen werden mit exponentiellem Backoff bis zu 5-mal innerhalb von 24 Stunden wiederholt.

  • Zustellungsprotokolle

    Vollständiger Zustellungsverlauf mit Anfrage-/Antwortkörpern, Statuscodes und Zeitangaben zur Fehlersuche.

  • Ereignisfilterung

    Abonnieren Sie nur die Ereignisse, die Sie interessieren. Filtern Sie nach Umfrage, Kampagne oder Ereignistyp.

Beispiel einer Webhook-Nutzlast
{
  "event": "response.created",
  "timestamp": "2026-04-05T14:30:00Z",
  "data": {
    "responseId": "resp_abc123",
    "surveyId": "srv_xyz789",
    "status": "completed",
    "completionTime": 245,
    "answers": [...]
  },
  "signature": "sha256=..."
}

Integrationen

Verbinden Sie Ihren gesamten Stack

Vorgefertigte Konnektoren für die beliebtesten Plattformen sowie Zapier und Make zur Verbindung mit Tausenden weiteren.

Automatisierung

Zapier

Verbinden Sie sich mit über 5.000 Apps über Trigger und Aktionen

Automatisierung

Make

Visuelle Workflow-Automatisierung mit komplexen Szenarien

CRM

Salesforce

Synchronisieren Sie Antworten mit Kontakten, Leads und Vorgängen

CRM

HubSpot

Ordnen Sie Umfragedaten Deals, Kontakten und Tickets zu

E-Mail

Mailchimp

Lösen Sie Umfragen aus E-Mail-Kampagnen und Segmenten aus

E-Mail

Klaviyo

Betten Sie Umfragen in Customer-Journey-Flows ein

Messaging

Slack

Verteilen Sie Umfragen und erhalten Sie Benachrichtigungen in Kanälen

Messaging

Microsoft Teams

Senden Sie Umfragen über Teams-Bots und -Registerkarten

Schnellstart

In 3 Schritten einsatzbereit

Von der Anmeldung bis zu Ihrem ersten API-Aufruf in unter 5 Minuten.

01

API-Schlüssel anfordern

Erstellen Sie ein kostenloses Konto und generieren Sie einen API-Schlüssel über Ihr Dashboard. Schlüssel sind pro Projekt begrenzt, mit konfigurierbaren Berechtigungen und Ratenbegrenzungen.

02

SDK installieren

Wählen Sie aus 4 nativen SDKs oder verwenden Sie die REST-API direkt. Jedes SDK enthält vollständige TypeScript-/Typdefinitionen, eine umfassende Dokumentation und Beispielcode.

03

Veröffentlichen

Erstellen Sie Ihre erste Umfrage, betten Sie sie in Ihre App ein und beginnen Sie, Antworten zu sammeln. Nutzen Sie Webhooks, um Echtzeit-Workflows auszulösen.

75+
API-Endpunkte
4
Native SDKs
99,9 %
API-Verfügbarkeit
<100ms
Durchschn. Antwortzeit

Beginnen Sie noch heute

Fordern Sie Ihren kostenlosen API-Schlüssel an und tätigen Sie Ihren ersten API-Aufruf in wenigen Minuten. Unser großzügiges kostenloses Kontingent umfasst 1.000 API-Anfragen pro Tag.

Kostenloser API-ZugriffKeine Kreditkarte erforderlichVollständige Dokumentation