Configuration

Préférences de site personnalisées

Après l’import des métadonnées, accédez à BM > Merchant Tools > Site Preferences > Custom Preferences.

Screenshot — Custom Preferences menu

Sélectionnez Kleep :

Screenshot — Kleep preferences group

Préférence	Description	Valeur recommandée
`kleepRetailerUUID`	Obligatoire. Identifiant unique de votre revendeur sur la plateforme Kleep, fourni par votre Account Manager Kleep. Doit être saisi manuellement — il est envoyé dans chaque appel API Kleep et utilisé comme paramètre `domain` de l’iframe de Recommandation pour résoudre votre compte. Aucun fallback automatique : s’il est vide, le tracking, la fonctionnalité de Recommandation et l’iframe ne fonctionneront pas (une erreur de configuration est déclenchée).	L’UUID fourni par votre Account Manager Kleep
`isKleepRecommendationEnabled`	Activer/désactiver le bouton Kleep sur la PDP. N’affecte pas le tracking ni les exports des jobs.	Yes
`kleepButtonColor`	Couleur du bouton (Noir ou Blanc). Remplacez via CSS pour un style personnalisé.	`White` ou `Black`, selon le design de votre PDP
`kleepFontFamily`	Famille de police pour le bouton Kleep et l’iFrame.	La police de votre boutique — optionnel
`kleepCountryCode`	Code marché / pays (ISO 3166 A-2).	Votre marché principal, ex. `FR`

Selon la version de votre cartridge, vous pouvez également voir isKleepSessionEnabled dans le Business Manager. Cette préférence existait dans les anciennes versions de la cartridge pour activer/désactiver le tracking de session Kleep ; elle a été supprimée dans les versions actuelles car la session est toujours active. Si elle est présente, laissez-la à sa valeur par défaut (Yes).

Services

Disponibles dans Administration > Operations > Services :

Screenshot — Services list

kleep.sftp — Envoie les fichiers d’export depuis le WebDAV SFCC vers le SFTP Kleep. Remplacez l’utilisateur par celui fourni par Kleep, ainsi que le certificat .p12. Ne définissez aucun mot de passe.

Screenshot — kleep.sftp service details

kleep — Utilisé pour toutes les autres fonctionnalités. Aucun identifiant nécessaire — la requête est authentifiée par la préférence de site kleepRetailerUUID, envoyée dans le payload de chaque appel API Kleep pour résoudre votre compte.

Clé privée et certificat

Accédez à Administration > Operations > Private Keys and Certificates :

Cliquez sur Import
Cliquez sur Select et choisissez le fichier .p12 fourni par Kleep
Utilisez kleep comme alias
Cliquez sur Save

Screenshot — Import certificate

Le résultat doit ressembler à ceci — il doit être valide et nommé kleep :

Screenshot — Imported certificate

Jobs d’export

Accédez à Administration > Operations > Jobs. La cartridge fournit trois jobs :

KleepExportProductsCSV — exporte les produits de votre site
KleepExportOrdersCSV — exporte l’historique des commandes de vos clients
KleepResetLastExported — job utilitaire pour forcer un re-export complet des commandes (détails ci-dessous)

Screenshot — Export jobs list

Les deux jobs d’export sont désactivés par défaut. Activez-les pour qu’ils s’exécutent une fois par jour (voir Planification et fréquence) :

Screenshot — Enabling an export job

Affectation des sites

Les deux jobs d’export s’exécutent dans un contexte de site. Dans l’onglet Job Steps, cliquez sur le scope de site (affiché RefArch sur une installation fraîche) et sélectionnez le(s) site(s) où vous utilisez Kleep. Chaque job d’export comporte deux étapes :

Une étape de génération (Custom.Kleep.GenerateProductsCSV ou Custom.Kleep.GenerateOrdersCSV) — écrit le fichier CSV dans un dossier IMPEX WebDAV
Une étape d’upload (Custom.CSComponents.FtpUpload) — pousse le CSV vers le serveur SFTP Kleep via le service kleep.sftp, puis archive le fichier

The TargetFolder parameter of each SFTP upload step must match the folder structure expected by Kleep’s ingestion pipeline. For example, a dev store might use dev/products instead of products. See the SFTP Data Structure documentation for the complete directory layout.

Paramètres de KleepExportProductsCSV

Screenshot — KleepExportProductsCSV job steps

Étape 1 — GenerateProductsCSV

Paramètre	Description	Valeur recommandée
`TargetFolder`	Dossier IMPEX où le CSV est écrit	`src/feeds/kleep/products`
`SkipMaster`	Ignorer les produits master pendant l’export	Décoché
`OnlineOnly`	Exporter uniquement les produits en ligne	Décoché
`ExportType`	`Delta` (produits mis à jour depuis le dernier export) ou `Full` (catalogue entier)	`Delta` — exécutez un export `Full` à la mise en production
`MainViewType`	Type de vue d’image utilisé pour résoudre les images produits. Utilisez le même que sur votre PDP.	`large` (à adapter à votre catalogue)
`Locale`	Locale utilisée pour générer les données. Utilise la valeur par défaut du site si vide.	Laisser vide

Le nombre de produits exportés peut dépasser le nombre traité. Cela se produit lorsque des produits non catégorisés sont inclus via leur association avec un VariationGroup catégorisé.

Assurez-vous que le paramètre MainViewType correspond à la configuration de votre boutique. Un type de vue incorrect entraîne des images produits manquantes, qui sont nécessaires pour l’analyse IA.

Screenshot — SFTPUpload step parameters (products)

Étape 2 — SFTPUpload

Paramètre	Valeur recommandée
`ServiceID`	`kleep.sftp`
`KeyAlias`	`kleep`
`FilePattern`	`._kleep-products_.\.csv`
`SourceFolder`	`src/feeds/kleep/products`
`TargetFolder`	`products`
`Recursive`	Décoché
`ArchiveFolder`	`src/feeds/kleep/products/archive`
`NoFileFoundStatus`	`OK`
`IsDisabled`	Décoché

Paramètres de KleepExportOrdersCSV

Étape 1 — GenerateOrdersCSV

Screenshot — GenerateOrdersCSV step parameters

Paramètre	Description	Valeur recommandée
`TargetFolder`	Dossier IMPEX où le CSV est écrit	`src/feeds/kleep/orders`
`Timeout`	Secondes avant l’arrêt de l’export	`900`
`OrdersMaxToExport`	Nombre maximum de commandes exportées par exécution	`1000`

Étape 2 — SFTPUpload

Paramètre	Valeur recommandée
`ServiceID`	`kleep.sftp`
`KeyAlias`	`kleep`
`FilePattern`	`._kleep-orders_.\.csv`
`SourceFolder`	`src/feeds/kleep/orders`
`TargetFolder`	`orders`
`Recursive`	Décoché
`ArchiveFolder`	`src/feeds/kleep/orders/archive`
`NoFileFoundStatus`	`OK`
`IsDisabled`	Décoché

Planification et fréquence

Job	Fréquence	Planification de référence	Notes
`KleepExportProductsCSV`	Quotidien	04:00 UTC, tous les jours	Export `Delta` — léger en ressources
`KleepExportOrdersCSV`	Quotidien	05:00 UTC, tous les jours	Exporte au maximum `OrdersMaxToExport` commandes par exécution
`KleepResetLastExported`	Jamais planifié	—	Exécution manuelle, à la demande uniquement

L’horaire exact n’a pas d’importance pour Kleep — choisissez une fenêtre de faible trafic pour votre instance et gardez les deux jobs d’export en quotidien. Décaler les deux jobs d’une heure (comme ci-dessus) évite une activité IMPEX et SFTP simultanée. Pour la gestion des erreurs, la configuration de référence relance une exécution échouée jusqu’à 3 fois à 1 minute d’intervalle.

À la mise en production, exécutez KleepExportProductsCSV une fois manuellement avec ExportType sur Full, puis repassez sur Delta pour la planification quotidienne.

KleepResetLastExported (job utilitaire)

KleepResetLastExported force un re-export complet des commandes. Son unique étape, Custom.Kleep.ResetKleepExportAttributes, efface les attributs de suivi d’export sur chaque commande (kleepLastExported → vide, isKleepExported → false) afin que toutes les commandes soient reprises lors des prochaines exécutions de KleepExportOrdersCSV. Il ne prend aucun paramètre. Exécutez-le uniquement lorsqu’un backfill complet des commandes est nécessaire :

Kleep vous demande de renvoyer l’historique des commandes (par exemple après une réinitialisation des données côté Kleep)
Vous avez corrigé une mauvaise configuration de l’export des commandes et souhaitez renvoyer des commandes déjà exportées

Gardez-le non planifié et exécutez-le manuellement : Administration > Operations > Jobs > KleepResetLastExported > Run Now.

KleepExportOrdersCSV exporte au maximum OrdersMaxToExport commandes par exécution (1 000 par défaut). Après un reset, un backfill de N commandes nécessite donc N / 1 000 exécutions — lancez le job commandes manuellement plusieurs fois, ou augmentez temporairement OrdersMaxToExport, puis restaurez-le.

Vérifications de stock en temps réel

Kleep interroge les stocks en temps réel pour éviter de recommander des tailles en rupture de stock. Configurez l’accès en utilisant l’une des deux méthodes ci-dessous.

Vous ne savez pas laquelle choisir ? OCAPI est l’approche traditionnelle utilisant l’API Data du Business Manager. SCAPI (IAS) est la nouvelle Salesforce Commerce API avec le service de disponibilité des stocks (Inventory Availability Service). Demandez à votre administrateur Salesforce en cas de doute.

OCAPI (Open Commerce API)
SCAPI — Inventory Availability Service (IAS)

Utilisez cette méthode si votre instance s’appuie sur OCAPI pour la gestion des stocks.Étape 1 — Ouvrir les paramètres OCAPIAccédez à Administration > Site Development > Open Commerce API Settings, puis modifiez les paramètres de l’API Data.Étape 2 — Configurer le Client IDPour les tests :

"client_id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Pour la production, générez un nouveau client ID conformément à la documentation Salesforce. Tutoriel vidéo.Étape 3 — Configurer l’accès aux ressourcesAjoutez ceci à vos configurations de l’API OCAPI Data :

Authorizations
(GET) /inventory_lists/*
(GET) /inventory_lists/*/product_inventory_records/*

Étape 4 — Envoyer les identifiants à Kleep

Client ID
Client Secret
IDs d’inventaire (un par marché — fournissez votre mapping)
URL SBX de production (les vérifications de stock ne sont activées qu’en production)

Utilisez cette méthode si votre instance utilise SCAPI avec le service de disponibilité des stocks (IAS) / Omnichannel Inventory (OCI).Étape 1 — Créer un client API

Connectez-vous à Salesforce Account Manager.
Cliquez sur API Client → Add API Client.
Nom d’affichage : par exemple Kleep Inventory.
Token Endpoint Auth Method : client_secret_post.
Access Token Format : JWT.
Allowed Scopes : sfcc.inventory.availability
Assignez à votre Organisation.
Enregistrez. Copiez le Client ID et le Client Secret — le secret n’est affiché qu’une seule fois.

Les clients SCAPI et OCAPI ne peuvent pas être partagés. Chaque framework API nécessite son propre client.

Étape 2 — Rassembler les identifiants d’instance

Identifiant	Où le trouver	Exemple
Short Code	BM > Administration > Site Development > Salesforce Commerce API Settings	`kv7kzm78`
Organization ID	Même page, ou Account Manager	`f_ecom_zzzz_prd`
Tenant ID	Account Manager > Organizations	`zzzz_prd`
Location Group(s)	BM > Merchant Tools > Inventory > Inventory Availability	`WAREHOUSE_FR`, `WAREHOUSE_US`

Étape 3 — Envoyer les identifiants à Kleep

Client ID & Client Secret
Short Code
Organization ID
Tenant ID
Location Group(s) (un par marché — fournissez votre mapping)

FAQ

Quels paramétrages définir pour chacun des jobs ?

Chaque job d’export a deux étapes — une étape de génération et une étape d’upload SFTP — et chaque paramètre avec sa valeur recommandée est listé dans Paramètres de KleepExportProductsCSV et Paramètres de KleepExportOrdersCSV. En pratique, seuls trois points sont à vérifier : l’affectation des sites dans l’onglet Job Steps, MainViewType (doit correspondre au type de vue d’image de votre PDP), et ExportType (Delta en quotidien, une exécution Full à la mise en production). Tout le reste peut garder sa valeur par défaut. KleepResetLastExported ne prend aucun paramètre.

Quelle est la fonction du job KleepResetLastExported, et quand l'exécuter ?

Il efface les attributs de suivi d’export (kleepLastExported, isKleepExported) sur toutes les commandes, afin que les prochaines exécutions de KleepExportOrdersCSV re-exportent l’historique complet. Exécutez-le manuellement, uniquement quand un backfill complet est nécessaire — typiquement à la demande de Kleep. Ne le planifiez jamais. Voir KleepResetLastExported (job utilitaire).

Quelles site preferences faut-il configurer ?

Le minimum fonctionnel : kleepRetailerUUID (obligatoire — fourni par votre Account Manager Kleep), isKleepRecommendationEnabled sur Yes, et kleepCountryCode sur votre marché principal. kleepButtonColor et kleepFontFamily sont des préférences de style optionnelles. Voir Préférences de site personnalisées.

À quelle fréquence (et à quel horaire) exécuter les jobs ?

Les deux jobs d’export s’exécutent une fois par jour, tous les jours. La planification de référence est 04:00 UTC pour les produits et 05:00 UTC pour les commandes, mais l’horaire exact n’a pas d’importance pour Kleep — choisissez une fenêtre de faible trafic et gardez environ une heure entre les deux jobs. KleepResetLastExported n’est jamais planifié. Voir Planification et fréquence.

Je vois isKleepSessionEnabled dans le Business Manager mais pas dans cette doc — qu'est-ce que c'est ?

Cette préférence existait dans les anciennes versions de la cartridge pour activer/désactiver le tracking de session Kleep. Elle a été supprimée dans les versions actuelles car la session est toujours active. Si votre Business Manager l’affiche encore, laissez-la à sa valeur par défaut (Yes).

Bienvenue

CMS

Mobile

Données

Confidentialité

Préférences de site personnalisées

Services

Clé privée et certificat