Passer au contenu principal

Phase 1 : Configuration backend (API OAuth1)

Cette étape permet à Kleep de récupérer votre catalogue produits, l’historique des commandes et les données de retours afin de calibrer l’algorithme.

1. Créer une intégration OAuth1

  1. Connectez-vous à votre panneau d’administration Magento.
  2. Accédez à Système > Intégrations.
  3. Cliquez sur « Ajouter une nouvelle intégration ».
  4. Renseignez le champ Nom (par exemple, « Kleep Integration »).
  5. Saisissez votre mot de passe administrateur pour confirmer.

2. Configurer les permissions API

RoutesDétails
/products/*Accès à toutes les ressources produits
/categories/*Accès à toutes les ressources catégories
/orders/*Accès à toutes les ressources commandes
/returns/*Accès à toutes les ressources retours
/returnsAttributeMetadata/*Accès à toutes les ressources d’attributs de retours
/returnsItemAttributeMetadata/*Accès à toutes les ressources d’attributs d’articles retournés
/creditmemos/*Accès à toutes les ressources d’avoirs
/creditmemo/*Accès à une ressource avoir unique
/stockItems/*Accès à toutes les ressources de stock
/store/*Accès à toutes les ressources boutique
/inventory/*Accès à toutes les ressources d’inventaire
/customers/*Accès à toutes les ressources clients
Cela doit correspondre aux ACL suivantes dans Magento :
  • Magento_Catalog::products
  • Magento_Catalog::categories
  • Magento_Sales::sales
  • Magento_Sales::creditmemo
  • Magento_Sales::actions_view
  • Magento_Rma::rma
  • Magento_Rma::magento_rma
  • Magento_Rma::rma_attributes
  • Vendor_Module::returns
  • Magento_CatalogInventory::cataloginventory
  • Magento_Store::store
  • Magento_Config::config
  • Magento_Inventory::inventory
  • Magento_Customer::customer
⚠️ Important :
  • Si votre instance Magento expose des couches API supplémentaires ou des endpoints personnalisés (par exemple, des API de retours/RMA personnalisées), veuillez nous en informer.
  • Si vous utilisez un fournisseur de retours externe sans intégration via l’API Magento, veuillez vous référer à la documentation sur les données de retours ou nous contacter pour choisir la bonne méthode d’intégration.

3. Activer et récupérer les identifiants

  1. Cliquez sur « Enregistrer » pour créer l’intégration.
  2. Cliquez sur « Activer » sur l’intégration nouvellement créée.
  3. Une fenêtre contextuelle affichera vos identifiants OAuth :
    • Consumer Key
    • Consumer Secret
    • Access Token
    • Access Token Secret
  4. Copiez ces identifiants — vous devrez les envoyer à votre contact Kleep.
Pour obtenir des conseils sur la création et la récupération des identifiants API Magento 2, veuillez vous référer à :
Tutoriel Subscribe Pro : Créer et récupérer les identifiants API Magento 2 Tutoriel officiel Adobe : Authentification OAuth Magento 2

4. Envoyer les identifiants à Kleep

Veuillez envoyer les informations suivantes à votre contact Kleep par e-mail :
  1. Veuillez fournir la ou les URL de base API complètes pour la ou les boutiques.
  2. Identifiants OAuth1
    • Consumer Key
    • Consumer Secret
    • Access Token
    • Access Token Secret

Phase 2 : Intégration frontend (Widget)

Cette étape consiste à ajouter le script Kleep à vos pages produits (PDP). Compatible avec toutes les versions de Magento. Suivez notre guide Widget Bibliothèque JS pour installer et configurer le CTA frontend sur vos pages produits.

Phase 3 : Gestion des données manquantes (SFTP)

Cette section s’applique lorsque des données ne peuvent pas être récupérées via les endpoints API standard. Si votre API Magento ne permet pas de récupérer les retours ou certaines données spécifiques, nous procédons par échange de fichiers CSV. Veuillez vous référer à la documentation ci-dessous. Ce guide vous guidera pas à pas dans le processus de transmission des données manquantes :

Phase 4 : Validation & déploiement en production

1. Environnement de test

Déployez d’abord sur votre environnement Preprod/Staging.

2. Validation visuelle

Avant de passer en production, vérifiez les points suivants :
  • Le bouton s’affiche-t-il correctement ?
  • Un clic ouvre-t-il le pop-up (Drawer) ?
  • Pas d’erreurs « CORS » dans la console du navigateur ?

3. Mise en production

Une fois validé par vous et par l’équipe Kleep, déployez les modifications dans votre thème de Production.---

Cookies & confidentialité des données

Kleep est entièrement conditionné par le consentement du visiteur : le script ne se charge qu’après que le consentement a été collecté via votre CMP, et vous devez conditionner son chargement en conséquence. Pour la liste complète des traceurs, les données traitées, les finalités et bases légales, l’hébergement, les sous-traitants et la sécurité, consultez Cookies, CMP & confidentialité des données.