Seleccione el botón apropiado a continuación para obtener la documentación que contiene la información necesaria para trabajar con la API del portal Purple:
|
|
|
Purple utiliza autenticación mediante clave API. Nuestro archivo de demostración en PHP y la documentación de la API de empresa (v1.6.2 y v1.7) están disponibles para ayudarte a empezar, incluyendo la configuración y los requisitos del sistema de la API.
Postman es una plataforma API que facilita la creación y el uso de API. Se utiliza normalmente para realizar pruebas en el contexto de Purple. Consulta nuestra guía de configuración de Postman para obtener más información.
Una vez conectado, consulta la documentación de la API de empresa de nuestro portal para obtener ayuda. Esta documentación incluye la documentación más reciente de la API y todos los endpoints disponibles.
Con la API de tu portal, puedes consultar datos de usuario sin procesar desde tu portal y utilizarlos para alimentar sistemas externos (como un CRM). Si quieres exportar datos a tu CRM sin realizar solicitudes repetidas a la API de Purple, puedes usar webhooks. Los webhooks también se pueden usar para activar eventos en tiempo real mediante LogicFlow.
Es posible la integración de la API con los conectores de nuestra biblioteca. Esto normalmente lo realiza nuestro equipo de servicios profesionales.
Nuestra API no tiene límite de velocidad (es decir, admite cualquier número de solicitudes o transacciones).
Se requiere una licencia Enterprise para acceder a la API.
Cambios en la API 1.7
Con el lanzamiento de la API v1.7:
-
Se ha mejorado la claridad al mostrar el estado de suscripción de los usuarios finales. La propiedad "darse de baja" se ha actualizado para mostrar si el visitante ha cancelado la suscripción de marketing tras haberse suscrito previamente. Este cambio distingue claramente entre quienes se suscribieron y cancelaron la suscripción, y quienes nunca se suscribieron. Esto supone un cambio con respecto a la API v1.6.2, donde no se distingue entre quienes cancelaron la suscripción y quienes nunca se suscribieron.
-
Se ha corregido el nombre de la propiedad en la respuesta del endpoint "Cancelar suscripción", de "darse de baja" a "darse de baja".
-
Los endpoints "Visitantes" y "Lugares" ahora devuelven una respuesta HTTP 200 ("OK") cuando no se encuentran visitantes. Esto indica a los usuarios que los datos se muestran correctamente. Anteriormente, se mostraba una respuesta HTTP 404 ("No encontrado"), que podía dar la impresión de que se estaba produciendo un error.
Actualizar API a v1.7
Para cambiar la versión de la API de v1.6.2 a v1.7:
- Cambie todas las URL relevantes para incluir la v1.7.
- Actualizar todos los scripts o procesos que soliciten el punto final «Desuscritos» para que utilicen el nombre de propiedad de respuesta de datos corregido de «desuscritos».
Si emplea a un tercero para gestionar el uso de la API, pídale que la actualice con la información anterior.