Documentación para desarrolladores

Referencia de la API para desarrolladores

Crea integraciones personalizadas con nuestra API REST. Gestiona encuestas, recopila respuestas, lanza campañas y accede a las analíticas de forma programática.

Inicio rápido

Comienza en minutos

Inicio rápido

# URL base

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

# Autenticación: token Bearer en la cabecera

curl -H "Authorization: Bearer your_api_key" \

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

# Formato de respuesta: JSON

{

"data": [...],

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

}

Autenticación

Acceso seguro

Claves de API

Claves de API con alcance y permisos por endpoint. Envíalas mediante la cabecera Authorization: Bearer .

Tokens JWT

Tokens bearer de OAuth 2.0 para solicitudes en contexto de usuario. Envíalos mediante la cabecera Authorization .

Límite de solicitudes

60 solicitudes por minuto de forma predeterminada. Límites más altos en los planes Business (300/min) y Enterprise (personalizado).

Endpoints

Endpoints principales de la API

Todos los endpoints usan la URL base /api/v1 y devuelven respuestas en JSON.

Encuestas

GET/surveysLista todas las encuestas con paginación y filtros

POST/surveysCrea una nueva encuesta

GET/surveys/:idObtiene una encuesta por ID

PATCH/surveys/:idActualiza la configuración de la encuesta

DELETE/surveys/:idElimina una encuesta

GET/surveys/:id/responsesLista las respuestas de una encuesta

Respuestas

GET/responsesLista todas las respuestas con filtros

POST/responsesEnvía una respuesta de encuesta

GET/responses/:idObtiene una respuesta específica

DELETE/responses/:idElimina una respuesta

Campañas

POST/email-campaignsCrea una campaña de correo electrónico

POST/sms-campaignsCrea una campaña de SMS

POST/whatsapp-campaignsCrea una campaña de WhatsApp

POST/voice-distributionCrea una campaña de voz IVR

GET/email-campaigns/:idConsulta el estado de entrega de la campaña

Analíticas

GET/analytics/survey/:id/statsEstadísticas agregadas de respuestas

GET/analytics/survey/:id/trendsDatos de tendencias en series temporales

POST/analytics/ai/sentimentAnálisis de sentimiento con IA

POST/analytics/ai/summaryResumen ejecutivo con IA

Audiencias

GET/audiencesLista los grupos de audiencia

POST/audiencesCrea un grupo de audiencia

POST/audiences/:id/contactsAñade contactos a una audiencia

GET/audiences/:id/contactsLista los contactos de una audiencia

Webhooks

POST/webhooksCrea una suscripción a webhook

GET/webhooksLista las suscripciones a webhooks

DELETE/webhooks/:idElimina una suscripción a webhook

POST/webhooks/:id/testEnvía un evento de prueba

SDK

SDK oficiales para 4 plataformas

SDK listos para producción con soporte sin conexión, seguridad de tipos y documentación completa.

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 tipos de eventos de webhook

Suscríbete a eventos y recibe callbacks HTTP en tiempo real cuando ocurren acciones en tu cuenta.

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

Gestión de errores

Códigos de error

CódigoNombreDescripción

400Solicitud incorrectaParámetros o cuerpo de la solicitud no válidos

401No autorizadoClave de API ausente o no válida

403ProhibidoPermisos insuficientes para este recurso

404No encontradoEl recurso no existe

409ConflictoConflicto de estado del recurso (p. ej., duplicado)

422No procesableError de validación en el cuerpo de la solicitud

429Demasiadas solicitudesSe superó el límite de solicitudes

500Error del servidorError inesperado del servidor

Empieza a desarrollar hoy

Crea tu cuenta y genera una clave de API en segundos. El acceso completo a la API está disponible en todos los planes, incluido el gratuito.

Obtén tu clave de API Recursos para desarrolladores