API de personnalisation

Une clé unique spécifique à chaque implémentation d'API. Elle identifie l'application ou le client spécifique pour le reporting, les autorisations et la gestion. Fournie par Algonomy.

Exemple : apiClientKey=b0126f995ac848159d

Une clé unique qui identifie le site. Chaque client Algonomy possède une clé API unique pour séparer les données et le trafic des autres clients. Fournie par Algonomy.

Exemple : apiKey=4faeaf752ee40a0f

ID d'ajout au panier. Il peut s'agir d'un seul ID de produit ou d'une liste d'ID de produits. Si plusieurs produits sont ajoutés au panier, séparez les ID de produits à l'aide du caractère pipe "|".

Exemple : atcid=uv2345|xt1234

Bloquer le(s) élément(s) de contenu. Cela peut être un seul ID de contenu ou une liste d'ID de contenu. Si plusieurs ID de contenu sont spécifiés, séparez-les à l'aide du caractère pipe "|".

Exemple : bi=content__1|content__2

Nom de la fonction JavaScript à laquelle les données JSON seront transmises. Doit être spécifié pour JSONP. La valeur de ce paramètre est utilisée comme nom de la fonction js dans la réponse.

Exemple : callback=products_returned

Omet les données de catégorie (categoryIds et catégories) lorsqu'elles sont définies sur false. La valeur par défaut est true.

Exemple : categoryData=false

L'ID de la catégorie que le commerçant souhaite examiner. La valeur doit correspondre à l'ID externe fournie par le commerçant à Algonomy pour la catégorie.

Exemple : categoryId=902312

Liste des ID de contenu. Le contenu retourné est l'intersection entre la liste des ID de contenu passés dans l'appel API et le contenu de la campagne sélectionnée. Les ID de contenu multiples sont séparés par le caractère pipe "|".

Exemple : content_ids=content__13055|13056

Note: Les ID de contenu fournis doivent être des ID externes.

Valeur du panier. Utilisée pour les campagnes ciblées impliquant la valeur du panier. Exprimée en centimes ; par exemple, 10 $ est représenté par 1000.

Exemple : cv=9550 (ce qui équivaut à 95,50 $)

Vrai/faux. Si true, omet le HTML retourné dans la réponse du serveur Algonomy. Si false, la réponse inclut le HTML pour le placement défini dans la mise en page du champ html. La valeur par défaut est false.

Exemple : excludeHtml=true

La marque mise en avant sur la page. Utilisé pour définir la graine pour des stratégies basées sur la marque, comme les meilleures ventes de marque.

Exemple : fpb=Microsoft

Adresse IP de l'acheteur. À utiliser uniquement si la requête API ne provient pas de l'appareil de l'acheteur (par exemple, intégration côté serveur).

Exemple : ipor=255.255.255.255

Vrai/faux. La valeur par défaut est false. Si true, inclut la chaîne rcs.

Exemple : includeRcs=true

Vrai/faux. La valeur par défaut est false. Si true, la réponse inclura les informations de la règle pour le contenu sélectionné, notamment le nom de la règle et l’ID de la règle.

Exemple : includeRuleInfo=true

Vrai/faux. La valeur par défaut est false. Si true, la réponse inclura le score du contenu sélectionné pour chaque placement.

Exemple : includeScore=true

Vrai/faux. La valeur par défaut est false. Si true, la réponse inclura une liste de tags pour le contenu sélectionné.

Exemple : includeTags=true

Liste des identifiants de placement. Chaque identifiant est composé d'un type de page et d'un nom de placement. Les identifiants sont séparés par le caractère pipe "|".

Vous recevrez un contenu par placement. Tous les placements dans un appel doivent concerner le même type de page.

Exemple : placements=item_page.horizontal|item_page.vertical

Référent de l'acheteur avant de visualiser la page. Utilisé pour le reporting et le merchandising. Fortement recommandé.

Exemple : pref=http://www.google.com

Un seul ID de produit ou une liste d'ID de produits. Partie de la définition d'une commande sur la page de confirmation d'achat. Utilisez le caractère pipe "|" pour séparer les ID de produits.

Exemple : productId=uv2345|xt1234

Chaîne de cookie Algonomy. C'est le cookie Algonomy crypté pour l'utilisateur associé à la requête API. Il doit être transmis exactement tel qu'il a été reçu dans une réponse API précédente.

Les clients doivent veiller à préserver la valeur 'rcs' telle qu'elle a été servie. Le paramètre 'rcs' est toujours alphanumérique et sensible à la casse, avec une combinaison de lettres majuscules, de lettres minuscules et de chiffres.

Note: Le paramètre 'rcs' permet aux commerçants de fournir efficacement à la plateforme Algonomy un accès au cookie du navigateur Algonomy de l'utilisateur en agissant comme un proxy de cookie (ou un passage de cookie). Ce processus implique que le commerçant lise et écrive le cookie du navigateur Algonomy d'un utilisateur et le transmette à Algonomy via l'API côté serveur.

Produits récemment achetés par l'acheteur dans la session en cours. Cela peut être un seul ID de produit ou une liste d'ID de produits. Les produits mentionnés ici seront pris en compte avec les données historiques du système Algonomy. Utilisez le caractère pipe "|" pour séparer les ID de produits.

Exemple : recentlyPurchased=uv2345|xt1234

ID de région. Doit être cohérent avec l'ID utilisé dans le flux de contenu Engage.

Exemple : rid=Switzerland-France

Identifie une visite unique par un acheteur.  Les sessions sont utilisées par les modèles comportementaux (pour délimiter le comportement des utilisateurs dans une session d'achat) et les métriques de reporting.

Exemple : sessionId=93484

Fournir les segments d'utilisateur. Utilisé pour les campagnes ciblées par segment. Listez chaque segment au format segment_number:segment_name, et séparez les segments par le caractère pipe "|". Vous devez transmettre à la fois l'ID du segment et un nom de segment pour chaque segment.

Exemple : sgs=101:NewUser|202:Male

Lorsqu'il est défini sur true, retourne http/https selon la façon dont la variable est nommée dans la mise en page.

Exemple : ssl=true

Filtrer les contenus qui correspondent à une liste de tags en utilisant une logique avancée comme les opérateurs ET (&&), OU (||), et NON (!).

Note: Vous devez encoder en URL l'opérateur '&&'. Pour encoder une URL avec le caractère &, utilisez %26.

Plusieurs tags peuvent être transmis en utilisant le pipe "|" comme séparateur. Lorsque plusieurs tags sont transmis, le contenu retourné doit inclure tous les tags.

Exemple : tagFilter=(shoes||women)&&Nike

Filtre de (shoes OU women) ET Nike

Note: Vous pouvez également regrouper les expressions logiques pour combiner plusieurs expressions.

Affiner les contenus basés sur une liste de tags. Les tags dans cette liste seront appliqués comme filtre si des contenus correspondants sont disponibles. Si aucun contenu correspondant n'est disponible, ces tags ne seront pas appliqués comme filtres. Plusieurs tags peuvent être transmis en utilisant le pipe "|" comme séparateur.

Exemple : tagFilter=shoes||women&tagRefinement=Nike

Cela tenterait de retourner des contenus avec soit 'shoes' ET 'Nike' OU 'women' ET 'Nike'. Si aucun contenu n'a le tag Nike, il retournera quand même des contenus avec soit 'shoes' OU 'women'.

Note: tagRefinement sera uniquement appliqué si tagFilter est utilisé.

Clés et valeurs personnalisées qui décrivent l'acheteur actuel. Séparez les informations en utilisant un point-virgule et le caractère pipe "|".

Exemple : userAttribute=eye_color:blue;green|hair_color:brown

L'utilisation est la même que pour userAttribute, sauf que les attributs envoyés avec userAttributeReplace remplaceront toutes les valeurs précédemment envoyées pour cet attribut.

Exemple : userAttributeReplace=eye_color:black

Dans l'exemple ci-dessus, toutes les valeurs précédentes de eye_color seront supprimées et remplacées par black.

Si le même attribut est envoyé dans une même requête avec userAttribute et userAttributeReplace, alors la valeur envoyée dans userAttributeReplace aura la priorité.

Cet attribut prend également en charge la suppression des valeurs d'attribut. Exemple : userAttribute=eye_color:|hair_color:

Liste des emplacements avec des promotions basées sur la requête. Il s'agit d'un tableau d'objets JSON, chacun décrivant un seul emplacement.

Une liste des créations à afficher. Dans la plupart des cas, il n'y en aura qu'une seule.

L'URL de destination sera convertie à des fins de suivi des clics et redirigera vers l'URL d'origine.

HTML complet pour l'emplacement basé sur la mise en page et la campagne sélectionnée. Inclus dans la réponse par défaut. Désactivez-le en utilisant le paramètre de requête excludeHtml.

Une liste des créations à afficher. Dans la plupart des cas, il n'y en aura qu'une seule.

Soit 'ok', soit 'error'.