Magento

​

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

Esta etapa permite que o Kleep recupere seu catálogo de produtos, histórico de pedidos e dados de devoluções para calibrar o algoritmo.

​

1. Criar Integração OAuth1

1. Faça login no seu Painel de Administração do Magento.
2. Navegue até System > Integrations.
3. Clique em “Add New Integration”.
4. Preencha o campo Name (ex.: “Kleep Integration”).
5. Insira sua Admin Password para confirmar.

​

2. Configurar Permissões de API

Isso deve corresponder às seguintes ACLs 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 sua instância do Magento expõe camadas de API adicionais ou endpoints personalizados (por exemplo, APIs personalizadas de devoluções/RMA), por favor coordene conosco.
• Se você usa um provedor de devoluções externo sem integração pela API do Magento, consulte a documentação de dados de devoluções ou coordene conosco para escolher o método de integração correto.

​

3. Ativar e Recuperar Credenciais

1. Clique em “Save” para criar a integração.
2. Clique em “Activate” na integração recém-criada.
3. Um pop-up exibirá suas credenciais OAuth:
   • Consumer Key
   • Consumer Secret
   • Access Token
   • Access Token Secret
4. Copie essas credenciais – você precisará enviá-las ao seu contato Kleep.

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

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

​

4. Enviar Credenciais ao Kleep

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

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

---

​

Fase 2: Integração de Frontend (Widget)

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

---

​

Fase 3: Gerenciamento de Dados Ausentes (SFTP)

Esta seção se aplica quando os dados não podem ser recuperados por endpoints de API padrão. Se a sua API do Magento não permite recuperar Devoluções ou certos dados específicos, procedemos via troca de arquivos CSV. Consulte a documentação abaixo. Este guia o guiará pelo processo de transmissão de dados ausentes passo a passo:

---

​

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

​

1. Ambiente de Teste

Implante primeiro no seu ambiente de Pré-produção/Homologação.

​

2. Validação Visual

Antes de ir ao ar, verifique o seguinte:

• O botão é exibido corretamente?
• Ao clicar, abre o pop-up (Drawer)?
• Nenhum erro de “CORS” no console do navegador?

​

3. Ir ao Ar

Uma vez validado por você e pela equipe Kleep, implante as modificações no seu tema de Produção.---

​

Cookies e privacidade de dados

O Kleep é totalmente controlado pelo consentimento do visitante: o script só carrega após a coleta do consentimento pela sua CMP, e você deve condicionar o carregamento de acordo. Para a lista completa de rastreadores, os dados processados, as finalidades e bases legais, hospedagem, suboperadores e segurança, consulte Cookies, CMP e Privacidade de Dados.