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
- Inicia sesión en tu panel del inquilino
- Ve a Configuración > Claves API
- Haz clic en Crear Clave API
- 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_accessen tu plan.
Límite de Tasa
| Límite | Valor |
|---|---|
| Solicitudes por minuto por inquilino | 60 |
Los encabezados de límite de tasa se incluyen en cada respuesta:
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 57
Endpoints Disponibles
| Método | Endpoint | Descripción |
|---|---|---|
GET | /api/v2/submissions | Listar envíos |
GET | /api/v2/submissions/{id} | Obtener un envío |
POST | /api/v2/submissions | Crear un envío |
GET | /api/v2/products | Listar productos |
POST | /api/v2/products | Crear un producto |
GET | /api/v2/campaigns | Listar campañas |
POST | /api/v2/campaigns | Crear una campaña |
GET | /api/v2/webhooks/config | Obtener configuración de webhook |
PUT | /api/v2/webhooks/config | Actualizar configuración de webhook |
GET | /api/v2/webhooks/logs | Ver 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 Estado | Significado |
|---|---|
200 | Éxito |
201 | Creado |
400 | Solicitud Incorrecta (error de validación) |
401 | No Autorizado (clave API inválida o ausente) |
403 | Prohibido (permisos insuficientes) |
404 | No Encontrado |
429 | Demasiadas Solicitudes (límite de tasa alcanzado) |
500 | Error del Servidor |
Profundizar
- Autenticación -- detalles de las claves API
- API de Envíos -- crear y listar feedback
- API de Productos -- gestionar productos
- API de Campañas -- gestionar campañas
- Webhooks -- notificaciones de eventos en tiempo real