Magento

​

Fase 1: Configuração do Backend (API OAuth1)

Este passo permite ao Kleep recuperar o seu catálogo de produtos, histórico de encomendas e dados de devoluções para calibrar o algoritmo.

​

1. Criar Integração OAuth1

1. Inicie sessão no seu Painel de Administração do Magento.
2. Navegue até System > Integrations.
3. Clique em “Add New Integration”.
4. Preencha o campo Name (por exemplo, “Kleep Integration”).
5. Introduza a sua Admin Password para confirmar.

​

2. Configurar Permissões de API

Isto deve corresponder às seguintes ACL no 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:

• Se a sua instância Magento expõe camadas de API adicionais ou endpoints personalizados (por exemplo, APIs de devoluções/RMA customizadas), por favor coordene connosco.
• Se utiliza um fornecedor externo de devoluções sem integração através da API Magento, consulte a documentação de dados de devoluções ou coordene connosco para escolher o método de integração adequado.

​

3. Ativar e Obter Credenciais

1. Clique em “Save” para criar a integração.
2. Clique em “Activate” na integração recém-criada.
3. Um pop-up irá apresentar as suas credenciais OAuth:
   • Consumer Key
   • Consumer Secret
   • Access Token
   • Access Token Secret
4. Copie estas credenciais — terá de as enviar ao seu contacto Kleep.

Para orientações sobre como criar e obter credenciais de API do Magento 2, consulte:

Tutorial Subscribe Pro: Criar e obter credenciais de API do Magento 2 Tutorial oficial Adobe: Autenticação OAuth do Magento 2

​

4. Enviar Credenciais ao Kleep

Por favor, envie as seguintes informações ao seu contacto Kleep por e-mail:

1. Forneça o(s) URL(s) base completo(s) da API para a(s) loja(s).
2. Credenciais OAuth1
   • Consumer Key
   • Consumer Secret
   • Access Token
   • Access Token Secret

---

​

Fase 2: Integração Frontend (Widget)

Este passo envolve a adição do script Kleep às suas páginas de produto (PDP). Compatível com todas as versões do Magento. Siga o nosso guia do Widget da Biblioteca JS para instalar e configurar o CTA frontend nas suas páginas de produto.

---

​

Fase 3: Gestão de Dados em Falta (SFTP)

Esta secção aplica-se quando os dados não podem ser recuperados através dos endpoints API padrão. Se a sua API Magento não permitir a recuperação de Devoluções ou determinados dados específicos, procedemos via troca de ficheiros CSV. Consulte a documentação abaixo. Este guia irá guiá-lo pelo processo de transmissão dos dados em falta passo a passo:

---

​

Fase 4: Validação e Implementação em Produção

​

1. Ambiente de Teste

Implemente primeiro no seu ambiente de Preprod/Staging.

​

2. Validação Visual

Antes de entrar em produção, verifique o seguinte:

• O botão é apresentado corretamente?
• O clique abre o pop-up (Drawer)?
• Não há erros “CORS” na consola do browser?

​

3. Entrada em Produção

Uma vez validado por si e pela equipa Kleep, implemente as modificações no seu tema de Produção.---

​

Cookies e privacidade de dados

O Kleep está totalmente condicionado ao consentimento do visitante: o script só carrega após a recolha do consentimento através do seu CMP, e deve condicionar o seu carregamento em conformidade. Para a lista completa de trackers, os dados processados, as finalidades e bases legais, alojamento, subprocessadores e segurança, consulte Cookies, CMP e Privacidade de Dados.