Documentation développeur

Référence de l' API développeur

Créez des intégrations personnalisées avec notre API REST. Gérez les enquêtes, collectez les réponses, déclenchez des campagnes et accédez aux analyses de manière programmatique.

Démarrage rapide

Démarrez en quelques minutes

Démarrage rapide

# URL de base

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

# Authentification : jeton Bearer dans l'en-tête

curl -H "Authorization: Bearer your_api_key" \

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

# Format de réponse : JSON

{

"data": [...],

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

}

Authentification

Accès sécurisé

Clés d'API

Clés d'API à portée limitée avec des autorisations par endpoint. Transmettez-les via l'en-tête Authorization: Bearer .

Jetons JWT

Jetons bearer OAuth 2.0 pour les requêtes dans le contexte de l'utilisateur. Transmettez-les via l'en-tête Authorization .

Limitation du débit

60 requêtes par minute par défaut. Limites plus élevées sur les forfaits Business (300/min) et Enterprise (personnalisé).

Endpoints

Principaux endpoints de l'API

Tous les endpoints utilisent l'URL de base /api/v1 et renvoient des réponses au format JSON.

Enquêtes

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

Réponses

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

Campagnes

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

Analyses

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

Audiences

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

Webhooks

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

SDK

SDK officiels pour 4 plateformes

Des SDK prêts pour la production avec prise en charge hors ligne, sécurité de typage et documentation complète.

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 types d'événements de webhook

Abonnez-vous aux événements et recevez des callbacks HTTP en temps réel lorsque des actions se produisent dans votre compte.

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

Gestion des erreurs

Codes d'erreur

CodeNomDescription
400Requête incorrecteParamètres ou corps de requête non valides
401Non autoriséClé d'API manquante ou non valide
403InterditAutorisations insuffisantes pour cette ressource
404IntrouvableLa ressource n'existe pas
409ConflitConflit d'état de la ressource (p. ex. doublon)
422Non traitableErreur de validation dans le corps de la requête
429Trop de requêtesLimite de débit dépassée
500Erreur serveurErreur serveur inattendue

Commencez à développer dès aujourd'hui

Créez votre compte et générez une clé d'API en quelques secondes. L'accès complet à l'API est disponible sur tous les forfaits, y compris le forfait gratuit.

Obtenez votre clé d'APIRessources développeur