Saltar al contenido principal

Descripción General de la API REST v2

FeedbackPulse SaaS proporciona una API RESTful (v2) para el acceso programático a los datos de tu inquilino. Úsala para integrar el feedback en tus propias aplicaciones, crear paneles de control o automatizar flujos de trabajo.


URL Base

https://yourdomain.com/api/v2

Autenticación

Todas las solicitudes de la API requieren un token Bearer (clave API):

curl -H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
https://yourdomain.com/api/v2/submissions

Obtener una Clave API

  1. Inicia sesión en tu panel del inquilino
  2. Ve a Configuración > Claves API
  3. Haz clic en Crear Clave API
  4. Copia la clave inmediatamente (¡solo se muestra una vez!)

Las claves API se almacenan como hashes SHA256. La clave original no se puede recuperar.

Requisito de plan: El acceso a la API requiere el indicador de función api_access en tu plan.


Límite de Tasa

LímiteValor
Solicitudes por minuto por inquilino60

Los encabezados de límite de tasa se incluyen en cada respuesta:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 57

Endpoints Disponibles

MétodoEndpointDescripción
GET/api/v2/submissionsListar envíos
GET/api/v2/submissions/{id}Obtener un envío
POST/api/v2/submissionsCrear un envío
GET/api/v2/productsListar productos
POST/api/v2/productsCrear un producto
GET/api/v2/campaignsListar campañas
POST/api/v2/campaignsCrear una campaña
GET/api/v2/webhooks/configObtener configuración de webhook
PUT/api/v2/webhooks/configActualizar configuración de webhook
GET/api/v2/webhooks/logsVer registros de entrega de webhooks

Formato de Respuesta

Todas las respuestas son JSON:

{
"data": [...],
"meta": {
"current_page": 1,
"per_page": 15,
"total": 42
}
}

Respuestas de Error

{
"error": "Unauthenticated.",
"status": 401
}
Código de EstadoSignificado
200Éxito
201Creado
400Solicitud Incorrecta (error de validación)
401No Autorizado (clave API inválida o ausente)
403Prohibido (permisos insuficientes)
404No Encontrado
429Demasiadas Solicitudes (límite de tasa alcanzado)
500Error del Servidor

Profundizar