Página de Documentación de la API
FeedbackPulse proporciona una página de documentación de la API interactiva para que los inquilinos puedan explorar y probar los endpoints disponibles.
Acceder a la Documentación de la API
Navega a /api-docs desde el panel del inquilino para ver la referencia completa de la API.
Agrupación de Endpoints
Los endpoints están organizados por recurso:
| Recurso | Descripción |
|---|---|
| Envíos | Crear, leer, actualizar y gestionar envíos de feedback |
| Productos | Gestionar productos y sus configuraciones |
| Campañas | Crear y gestionar campañas de feedback |
| Webhooks | Configurar y gestionar suscripciones de webhook |
Detalles de los Endpoints
Cada entrada de endpoint muestra la siguiente información:
| Campo | Descripción |
|---|---|
| Método HTTP | El método de solicitud (GET, POST, PUT, DELETE) |
| URL | La ruta completa del endpoint |
| Parámetros | Parámetros requeridos y opcionales con tipos y descripciones |
| Ejemplo de Solicitud | Cuerpo de solicitud de muestra o parámetros de consulta |
| Ejemplo de Respuesta | Respuesta JSON de muestra con código de estado |
Autenticación
La página de documentación de la API incluye instrucciones de autenticación. Todas las solicitudes a la API requieren una clave de API en la cabecera de la solicitud:
Authorization: Bearer {your-api-key}
Las claves de API se pueden generar desde la página de Configuración del inquilino.
Copiar al Portapapeles
Cada endpoint incluye un comando cURL predefinido que se puede copiar al portapapeles con un solo clic, facilitando la prueba de endpoints desde el terminal.