Introducción a la API de Pristo
La API de Pristo permite que tus propios sistemas trabajen con Pristo CX de dos formas: enviar un evento que inicia una distribución basada en eventos para un contacto y generar un enlace de encuesta para un cuestionario. Ambas son solicitudes POST con un cuerpo JSON a la URL base https://api.pristo.io.
Cada solicitud a la API de Pristo lleva una clave API en el encabezado X-API-Key. Las claves se crean en la aplicación de Pristo CX, en Gestión > Claves API, y cada clave pertenece a un programa.
El acceso a la API forma parte de los planes Estándar y Pro. En el plan Gratis, la aplicación no muestra Claves API ni crea claves. Los eventos solo inician encuestas a través de distribuciones basadas en eventos, y la aplicación muestra Distribuciones solo en el plan Pro. Consulta Planes y límites.
Endpoints
Sección titulada «Endpoints»| Método y ruta | Qué hace | Guía |
|---|---|---|
POST /v1/events/send |
Registra un evento para un contacto de la población del programa de la clave API. Después, las distribuciones basadas en eventos activas que seleccionan ese tipo de evento envían su cuestionario. | Enviar un evento |
POST /v1/links/generate/{prjId} |
Crea un enlace de un solo uso o reutilizable a un cuestionario y devuelve su URL en https://go.pristo.io. |
Generar un enlace de encuesta |
Los esquemas completos de las solicitudes y las respuestas están en la referencia de la API (en inglés). La referencia solo está disponible en inglés.
Cómo funciona
Sección titulada «Cómo funciona»Eventos. Tu sistema informa lo que le pasó a un cliente, por ejemplo una compra. Pristo CX guarda el evento de inmediato y devuelve su eventId. Poco después, Pristo CX agrega o actualiza el contacto en la población del programa y revisa las distribuciones basadas en eventos activas. Cada distribución que selecciona este tipo de evento, y cuyos filtros cumplen el evento y el contacto, programa el envío del cuestionario por SMS o por correo electrónico.
Contactos. La API no tiene un endpoint aparte para los contactos. Los contactos se crean y se actualizan a partir del objeto contact que envías con cada evento.
Enlaces de encuesta. Pides un enlace a un cuestionario y envías la url que recibes a un encuestado por tu propio canal, como un chat, un recibo o una aplicación. Un enlace de un solo uso recopila una respuesta. Un enlace reutilizable recopila una respuesta nueva cada vez que alguien lo abre.
Convenciones
Sección titulada «Convenciones»| Tema | Regla |
|---|---|
| URL base | https://api.pristo.io |
| Autenticación | X-API-Key: <your key> en cada solicitud. Consulta Autenticarse con una clave API |
| Cuerpo de la solicitud | JSON, con el encabezado Content-Type: application/json. Como máximo 10 000 bytes |
| Respuesta correcta | 200 OK con un objeto JSON pequeño |
| Errores | La mayoría de las respuestas 400 y 404 tienen un cuerpo de texto sin formato, no JSON. Consulta Errores de la API |
| ID | Los ID de cuestionario y los ID de evento son ID cortos de 22 caracteres. Los ID de enlace son UUID estándar |