Saltar al contenido principal
La Data API es una API REST que recupera o escribe datos almacenados en los servidores remotos de Kameleoon. Use los endpoints disponibles para:
  • Recuperar eventos de visita de un visitante determinado.
  • Enviar eventos de visita adicionales para un visitante determinado, como eventos de conversión offline.
  • Enviar y recuperar datos de producto para un sitecode determinado.
  • Almacenar datos adicionales para un visitante determinado, como datos de CRM o de segmentación.

Endpoints de la Data API

Los endpoints se dividen en tres categorías principales de datos:

Endpoints de visita

Los endpoints de visita recuperan y envían eventos (conversiones, datos personalizados, segmentos y más) para un código de visitante determinado. Use estos endpoints para importar a Kameleoon datos de compras offline, como compras en tienda física.
  • GET /visit/visitor: este endpoint recupera datos de visitas recopilados por Kameleoon, como experimentos y personalizaciones disparados para el usuario o segmentos objetivo.
El acceso a este endpoint requiere la solución Feature Experimentation de Kameleoon. Para más detalles, contacte con el Customer Success Manager.
  • POST /visit/forget: este endpoint elimina datos para varios visitantes.
  • POST /visit/events: este endpoint publica datos para un visitante determinado, como eventos de conversión y de página vista.

Endpoints de producto

Los endpoints de producto recuperan y envían datos de producto para un sitecode determinado. Use estos endpoints para registrar eventos de producto como vista, añadir al carrito o eventos de compra, o para obtener estadísticas sobre productos concretos (por ejemplo, conteos históricos de compras o vistas).
  • POST /product/events: este endpoint publica atributos (nombre, precio, etc.) y eventos (vista, añadir al carrito, compra) para varios productos. La Activation API utiliza los métodos obtainProductData y obtainProductInteractions para recuperar y usar estos datos para segmentación o recomendaciones.
  • GET /product/productCounters: este endpoint recupera conteos (número de vistas, cantidades añadidas al carrito, cantidades de transacciones) para varios productos.
  • GET /product/productData: este endpoint recupera atributos para varios productos.
Se requiere acceso al módulo Product Recommendation o al add-on Product Targeting. Ambos se integran con la solución Web Experimentation. Para más información, contacte con el Customer Success Manager.

Endpoints de map

Los endpoints de map almacenan datos adicionales para una clave determinada (normalmente un código de visitante o un User ID interno). La Activation API y todos los SDKs usan el método retrieveDataFromRemoteSource para recuperar y usar estos datos para segmentación. Use el endpoint map para recuperar los datos almacenados para una clave específica.
  • GET /map/map: este endpoint recupera datos para una clave determinada.
  • GET /map/maps: este endpoint recupera datos para varias claves.
  • POST /map/maps: este endpoint publica datos para varias claves.

Autenticación y rate limiting

Autenticación

La Data API utiliza el mismo flujo de autenticación que la Automation API, usando JSON web tokens. Mantenga la seguridad y proteja las credenciales de API utilizando autenticación para tipos específicos de solicitudes:
  • Fuentes server-side: para solicitudes que se originan en sus servidores, se recomienda encarecidamente la autenticación, lo que aumenta los rate limits. Autentique cuando use SDKs server-side con Feature Experimentation.
  • Fuentes client-side: para solicitudes que se originan en una aplicación cliente, como un navegador web, donde las credenciales de API podrían quedar expuestas, no se autentique. Esta configuración no se recomienda al usar Kameleoon Web Experimentation.
Cualquier solicitud que proporcione un token de API con formato incorrecto, un token caducado o una firma inválida resulta en una respuesta HTTP 401 “Unauthorized”. Para más información sobre el proceso de autenticación, consulte la documentación del flujo de autenticación de la Automation API.
Por defecto, no se requiere autenticación porque la Data API da soporte al motor de Web Experimentation para recuperar datos históricos. Si utiliza Feature Experimentation y SDKs server-side exclusivamente, contacte con el Customer Success Manager para habilitar la autenticación en endpoints específicos. Kameleoon ofrece una configuración flexible para asegurar endpoints y restringir la autenticación a solicitudes GET o POST.

Rate limits

La Data API aplica rate limits basados en sus Monthly Unique Visitors (MUV) contractuales y en la dirección IP del solicitante. Si su aplicación supera cualquiera de estos límites, la API devolverá una respuesta HTTP 429 - “Too Many Requests”. Estos rate limits existen para garantizar que el servicio de Kameleoon mantenga un rendimiento óptimo y sea fiable para todos los clientes. Para las fuentes server-side, los límites basados en IP pueden eliminarse mediante la autenticación.
Tipo de solicitudLímites aplicados a todas las solicitudesLímites adicionales aplicados solo a las solicitudes no autenticadas
Solicitudes GET(500.000 + número de MUV) / 500 solicitudes por minuto por cuenta de cliente120 solicitudes por minuto por IP
Otros métodos HTTP(500.000 + número de MUV) / 50 solicitudes por minuto por cuenta de cliente (por método)1.200 solicitudes por minuto por IP (por método)
Si necesita rate limits más altos para su caso de uso, contacte con su Account Manager para más información.