Passer au contenu principal
La Data API est une API REST qui récupère ou écrit des données stockées sur les serveurs distants de Kameleoon. Utilisez les endpoints disponibles pour :
  • Récupérer les événements de visite pour un visiteur donné.
  • Envoyer des événements de visite supplémentaires pour un visiteur donné, tels que des événements de conversion hors ligne.
  • Envoyer et récupérer des données de produit pour un sitecode donné.
  • Stocker des données supplémentaires pour un visiteur donné, telles que des données CRM ou de segmentation.

Endpoints de la Data API

Les endpoints se répartissent en trois catégories principales de données :

Endpoints Visit

Les endpoints Visit récupèrent et envoient des événements (conversions, custom data, segments, etc.) pour un code visiteur donné. Utilisez ces endpoints pour importer dans Kameleoon des données d’achat hors ligne, telles que les achats en magasin physique.
  • GET /visit/visitor : cet endpoint récupère les données de visites collectées par Kameleoon, telles que les expériences et personnalisations déclenchées pour l’utilisateur ou les segments ciblés.
L’accès à cet endpoint nécessite la solution Kameleoon Feature Experimentation. Pour plus de détails, contactez le Customer Success Manager.
  • POST /visit/forget : cet endpoint supprime les données de plusieurs visiteurs.
  • POST /visit/events : cet endpoint publie des données pour un visiteur donné, telles que des événements de conversion et de page vue.

Endpoints Product

Les endpoints Product récupèrent et envoient des données de produit pour un sitecode donné. Utilisez ces endpoints pour enregistrer des événements liés aux produits tels que les vues, les ajouts au panier ou les achats, ou pour obtenir des statistiques sur des produits spécifiques (par exemple, l’historique du nombre d’achats ou de vues).
  • POST /product/events : cet endpoint publie des attributs (nom, prix, etc.) et des événements (vue, ajout au panier, achat) pour plusieurs produits. L’Activation API utilise les méthodes obtainProductData et obtainProductInteractions pour récupérer et utiliser ces données à des fins de ciblage ou de recommandations.
  • GET /product/productCounters : cet endpoint récupère les comptages (nombre de vues, quantités ajoutées au panier, quantités de transactions) pour plusieurs produits.
  • GET /product/productData : cet endpoint récupère les attributs de plusieurs produits.
L’accès au module Product Recommendation ou au module complémentaire Product Targeting est requis. Tous deux s’intègrent à la solution Web Experimentation. Pour plus d’informations, contactez le Customer Success Manager.

Endpoints Map

Les endpoints Map stockent des données supplémentaires pour une clé donnée (généralement un code visiteur ou un ID utilisateur interne). L’Activation API et tous les SDK utilisent la méthode retrieveDataFromRemoteSource pour récupérer et utiliser ces données à des fins de ciblage et de segmentation. Utilisez l’endpoint map pour récupérer les données stockées pour une clé spécifique.
  • GET /map/map : cet endpoint récupère les données pour une clé donnée.
  • GET /map/maps : cet endpoint récupère les données pour plusieurs clés.
  • POST /map/maps : cet endpoint publie des données pour plusieurs clés.

Authentification et limitation de débit

Authentification

La Data API utilise le même flux d’authentification que l’Automation API, en utilisant des JSON Web Tokens. Maintenez la sécurité et protégez vos identifiants d’API en utilisant l’authentification pour des types de requêtes spécifiques :
  • Sources côté serveur : pour les requêtes provenant de vos serveurs, l’authentification est fortement recommandée et augmente les limites de débit. Authentifiez-vous lorsque vous utilisez des SDK côté serveur avec Feature Experimentation.
  • Sources côté client : pour les requêtes provenant d’une application cliente, telle qu’un navigateur web, où les identifiants d’API pourraient être exposés, ne vous authentifiez pas. Cette configuration n’est pas recommandée lors de l’utilisation de Kameleoon Web Experimentation.
Toute requête fournissant un token d’API avec un format incorrect, un token expiré ou une signature invalide entraîne une réponse HTTP 401 « Unauthorized ». Pour en savoir plus sur le processus d’authentification, consultez la documentation Flux d’authentification de l’Automation API.
Par défaut, l’authentification n’est pas requise car la Data API prend en charge le moteur de web experimentation pour la récupération des données historiques. Si vous utilisez Feature Experimentation et les SDK côté serveur exclusivement, contactez le Customer Success Manager pour activer l’authentification sur des endpoints spécifiques. Kameleoon propose une configuration flexible pour sécuriser les endpoints et restreindre l’authentification aux requêtes GET ou POST.

Limites de débit

La Data API applique des limites de débit en fonction de votre nombre contractuel de visiteurs uniques mensuels (MUV) et de l’adresse IP du demandeur. Si votre application dépasse l’une de ces limites, l’API renverra une réponse HTTP 429 - « Too Many Requests ». Ces limites de débit sont en place pour garantir que le service Kameleoon reste performant et fiable pour tous les clients. Pour les sources côté serveur, les limites basées sur l’IP peuvent être levées en s’authentifiant.
Type de requêteLimites appliquées à toutes les requêtesLimites supplémentaires appliquées uniquement aux requêtes non authentifiées
Requêtes GET(500,000 + nombre de MUV) / 500 requêtes par minute par compte client120 requêtes par minute par IP
Autres méthodes HTTP(500,000 + nombre de MUV) / 50 requêtes par minute par compte client (par méthode)1,200 requêtes par minute par IP (par méthode)
Si vous avez besoin de limites de débit plus élevées pour votre cas d’usage, veuillez contacter votre Account Manager pour plus d’informations.