Saltar al contenido principal

Fase 1: Configuración del backend (API OAuth1)

Este paso permite a Kleep recuperar tu catálogo de productos, historial de pedidos y datos de devoluciones para calibrar el algoritmo.

1. Crear la integración OAuth1

  1. Inicia sesión en tu Panel de administración de Magento.
  2. Ve a System > Integrations.
  3. Haz clic en “Add New Integration”.
  4. Rellena el campo Name (por ejemplo, «Kleep Integration»).
  5. Introduce tu Admin Password para confirmar.

2. Configurar los permisos de la API

RutasDetalles
/products/*Acceso a todos los recursos de productos
/categories/*Acceso a todos los recursos de categorías
/orders/*Acceso a todos los recursos de pedidos
/returns/*Acceso a todos los recursos de devoluciones
/returnsAttributeMetadata/*Acceso a todos los recursos de atributos de devoluciones
/returnsItemAttributeMetadata/*Acceso a todos los recursos de atributos de artículos de devoluciones
/creditmemos/*Acceso a todos los recursos de notas de crédito
/creditmemo/*Acceso a recursos de una nota de crédito individual
/stockItems/*Acceso a todos los recursos de stock
/store/*Acceso a todos los recursos de tienda
/inventory/*Acceso a todos los recursos de inventario
/customers/*Acceso a todos los recursos de clientes
Esto debería corresponder a los siguientes ACL en 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
⚠️ Importante:
  • Si tu instancia de Magento expone capas de API adicionales o endpoints personalizados (por ejemplo, APIs de devoluciones/RMA personalizadas), coordínalo con nosotros.
  • Si utilizas un proveedor de devoluciones externo sin integración a través de la API de Magento, consulta la documentación de datos de devoluciones o coordínate con nosotros para elegir el método de integración adecuado.

3. Activar y recuperar las credenciales

  1. Haz clic en “Save” para crear la integración.
  2. Haz clic en “Activate” en la integración recién creada.
  3. Aparecerá una ventana emergente con tus credenciales OAuth:
    • Consumer Key
    • Consumer Secret
    • Access Token
    • Access Token Secret
  4. Copia estas credenciales — deberás enviarlas a tu contacto de Kleep.
Para obtener orientación sobre cómo crear y recuperar las credenciales de la API de Magento 2, consulta:
Tutorial de Subscribe Pro: Crear y obtener credenciales de la API de Magento 2 Tutorial oficial de Adobe: Autenticación OAuth de Magento 2

4. Enviar las credenciales a Kleep

Envía la siguiente información a tu contacto de Kleep por correo electrónico:
  1. Proporciona la(s) URL(s) base completa(s) de la API para la(s) tienda(s).
  2. Credenciales OAuth1
    • Consumer Key
    • Consumer Secret
    • Access Token
    • Access Token Secret

Fase 2: Integración frontend (Widget)

Este paso consiste en añadir el script de Kleep a tus páginas de producto (PDP). Compatible con todas las versiones de Magento. Sigue nuestra guía del Widget de la Biblioteca JS para instalar y configurar el CTA de frontend en tus páginas de producto.

Fase 3: Gestión de datos faltantes (SFTP)

Esta sección se aplica cuando los datos no pueden recuperarse a través de los endpoints estándar de la API. Si tu API de Magento no permite recuperar Devoluciones o ciertos datos específicos, procedemos mediante intercambio de archivos CSV. Consulta la documentación a continuación. Esta guía te llevará paso a paso por el proceso de transmisión de datos faltantes:

Fase 4: Validación y despliegue en producción

1. Entorno de pruebas

Despliega primero en tu entorno de Preprod/Staging.

2. Validación visual

Antes de salir en vivo, verifica lo siguiente:
  • ¿El botón se muestra correctamente?
  • ¿Al hacer clic se abre la ventana emergente (Drawer)?
  • ¿No hay errores «CORS» en la consola del navegador?

3. Salida en vivo

Una vez validado por ti y por el equipo de Kleep, despliega las modificaciones en tu tema de Producción.---

Cookies y privacidad de datos

Kleep está completamente condicionado por el consentimiento del visitante: el script solo se carga después de que se recopile el consentimiento a través de tu CMP, y debes condicionar su carga en consecuencia. Para la lista completa de rastreadores, los datos tratados, las finalidades y bases legales, el alojamiento, los subencargados y la seguridad, consulta Cookies, CMP y privacidad de datos.