Introdução

Nesta seção, explicaremos como implementar o plugin Magento 1 em sua plataforma conforme o produto contratado.

Introduction

In this section, we will explain how to implement the Magento 1 plugin on your platform as per the contracted product.

Pré-Requisitos

Ter instalado em sua loja o Magento nas versões: 1.6.x, 1.7.x, 1.8.x, ou 1.9.x.

Utilizar padrão de endereço brasileiro com 4 campos (rua, número, bairro e complemento).

Utilizar CPF/CNPJ através do campo taxvat.

Crons habilitadas.

Checkout padrão do Magento.

Template (theme) desenvolvido utilizando as boas práticas segundo documentação do Magento.

Sempre utilizar a última versão do módulo Clearsale

Salientando que módulos de terceiros podem impactar no funcionamento do módulo da Clearsale, ou vice versa.

Não nos responsabilizamos nestes casos e não possuímos suporte à fornecedores terceiros.

Instalar o plugin conforme o produto contratado (Total, Total Garantido ou Application).


Clique aqui para fazer o download do arquivo de instalação do plugin.

Prerequisites

Have Magento 1.9.0 or higher installed in your store.

Install the plugin according to the contracted product (Total, Total Garantido or Application).


Click here to download plugin installation file.

Instalação

Você deverá descompactar os arquivos do módulo raiz da sua instalação da loja Magento.

Installation

You will need to unzip the root module files from your Magento store installation.

Resolução de Problemas

Página 404 ao acessar a configuração no admin: Efetuar a limpeza de cache, efetuar logout e fazer novamente o login no painel administrativo.

Caso não apareça as configurações do módulo: Verificar se a estrutura de pastas foi criada corretamente e se em sua configuração o módulo está ativo.

Caso esteja ativo e mesmo assim o módulo não apareça verifique as permissões nos arquivos instalados.

Troubleshooting

Page 404 when accessing configuration in admin: Clear cache, log out, and log back in to the admin panel.

If no module settings appear: Verify that the folder structure has been created correctly and that in its configuration the module is active.

If it is active and yet the module does not appear check the permissions on the installed files.

Configuração

O módulo do Magento 1 para os produtos Total, Total Garantido e Application é composto por 5 sub-módulos. São eles:


    Base

    Profiler (Integração de Contas)

    Total

    Device Fingerprint

    Mapper


Juntos esses sub-módulos fazem a integração completa do produto Clearsale bem como as ferramentas complementares para a prevenção de fraude em sua loja.

Para acessar as configurações você poderá acessar: Sistema -> Configuração -> Clearsale -> Base


Base


Ambiente: Ambiente da Clearsale para onde os pedidos serão enviados.

Selecione “Produção” para o envio de pedidos reais realizados em sua loja.

Nome da loja: Nesse campo você deverá inserir o nome de usuário de integração da loja fornecido pela Clearsale.

Senha da Integração: Nesse campo você deverá inserir a senha de integração fornecida pela Clearsale.

Habilitar log: Habilitar ou não o registro de logs (Recomendável habilitar).

Atributo CPF/CNPJ: Campo para mapear qual atributo do Magento é utilizado para informar o CPF/CNPJ do cliente.

Mapeamento de Endereço


Rua: Para mapear qual campo é utilizado para informar o logradouro do endereço em seu checkout.

Número: Para mapear qual campo é utilizado para informar o número do endereço em seu checkout.

Complemento: Para mapear qual campo é utilizado para informar o complemento do endereço em seu checkout.

Bairro: Para mapear qual campo é utilizado para informar o bairro do endereço em seu checkout.

Filtros


Forma de pagamento por cartão de crédito: Campo para mapear quais meios de pagamento da loja correspondem com Cartão de Crédito.

Forma de pagamento por cartão de débito: Campo para mapear quais meios de pagamento da loja correspondem com Cartão de Débito.

Forma de pagamento por boleto: Campo para mapear quais meios de pagamento da loja correspondem com Boleto Bancário.

Forma de pagamento por paypal: Campo para mapear quais meios de pagamento da loja correspondem com PayPal.

Forma de pagamento por depósito bancário: Campo para mapear quais meios de pagamento da loja correspondem com Depósito Bancário.

Forma de pagamento por transferência bancária: Campo para mapear quais meios de pagamento da loja correspondem com Transferência Bancária.

Fingerprint

O módulo do fingerprint é responsável por identificar e detectar o dispositivo que está sendo utilizado para realizar a compra na loja.


Utiliza Google Tag Manager: Campo para ativar o Google Tag Manager caso você o possua em sua loja.

Nome do App: Campo onde é preenchido o código do app do Fingerprint fornecido pela Clearsale.

Mapper

O módulo do Mapper é responsável por mapear o comportamento de navegação do usuário nas páginas da loja.


App code: Campo onde é preenchido o código do app do Mapper fornecido pela Clearsale.

Profiler

O módulo do Profiler é responsável pelo envio dos eventos realizados na conta do usuário na loja como criação e alteração dos dados do cadastro, login/logout e reset de senha.


Nome do campo de cpf/cnpj: Campo para mapear qual atributo do Magento é utilizado para informar o CPF/CNPJ do cliente.

Total


Habilitado: Campo responsável por habilitar ou não o módulo Clearsale.

URL da API de Produção: Campo por alterar a URL da API de produção de ClearSale, caso necessário.

URL da API de Homologação: Campo por alterar a URL da API de homologação de ClearSale, caso necessário.

Enviar pedido editado: Campo para habilitar o envio de pedidos que foram editados no Magento, onde a plataforma acrescenta um “-1” após o número do pedido.

Formas de pagamento: Campo para escolher as formas de pagamento dos pedidos a serem enviados para a análise da Clearsale.

Cancelar automaticamente: Campo para habilitar ou não o cancelamento automático dos pedidos caso a resposta de análise da Cleasale seja negativa.

Situação do pedido na avaliação: Campo para escolher qual será o status do pedido durante a análise da Clearsale.

Situação do pedido após aprovação: Campo para escolher qual será o status do pedido após a aprovação da Clearsale.

Situação do pedido após reprovação: Campo para escolher qual será o status do pedido após a reprovação da Clearsale.

Situação do pedido liberado manualmente: Campo para escolher qual será o status do pedido após a liberação manual.

Frequência da Cron: Campo para alterar a frequência de execução da cron de envio de pedidos para análise.

Número de pedidos enviados por vez a cada execução: Campo para alterar a quantidade de pedidos que serão enviados a cada execução da cron.

Notificação de Atualização de Status

Sempre que ocorrer alteração no status de um pedido, o Webhook da Clearsale irá enviar uma notificação para um URL.


Essa configuração funciona da seguinte forma:

    URL_DA_LOJA + /clearsaletotal/notification/index


Exemplo:

    http://lojadeteste.com.br/clearsaletotal/notification/index


Encaminhe essa URL para a equipe de integração através do e-mail integracao@clear.sale para que essa URL seja configurada na base da Clearsale.

Marcação de Chargeback

Na tela dos pedidos existem 2 abas, uma delas é responsável pela marcação de chargeback de um pedido já integrado e aprovado na Clearsale.


Exemplo:


Atualização de Status

A outra aba da tela de pedidos se refere a atualização de status de pagamento.

Caso em sua regra de negócio o processamento do pagamento ocorrer depois do envio do pedido e decisão da Clearsale, é possível que você nos informe qual foi a finalização do mesmo através deste serviço.


Exemplo:


Configuration

The Magento 1 module for Total, Total Garantido and Application products consists of 5 submodules. Are they:


    Base

    Profiler (Account Integration)

    Total

    Device Fingerprint

    Mapper


Together these submodules make the complete integration of the Clearsale product as well as the complementary fraud prevention tools in your store.

To access the settings you will be able to access: Sistema -> Configuração -> Clearsale -> Base


Base


Ambiente: Clearsale environment where orders will be shipped

Select "Produção" to ship actual orders placed in your store.

Nome da loja: In this field you must enter the store integration username provided by Clearsale.

Senha da Integração: In this field you must enter the integration password provided by Clearsale.

Habilitar log: Enable or disable logging (Recommended to enable).

Atributo CPF/CNPJ: Field to map which Magento attribute is used to inform the client's CPF/CNPJ.

Address Mapping


Rua: To map which field is used to inform the address of your checkout address.

Número: To map which field is used to enter the address number at your checkout.

Complemento: To map which field is used to enter the address complement in your checkout.

Bairro: To map which field is used to inform the neighborhood of the address at your checkout.

Filters


Forma de pagamento por cartão de crédito: Field to map which store payment methods correspond with Credit Card.

Forma de pagamento por cartão de débito: Field to map which store payment methods correspond with Debit Card.

Forma de pagamento por boleto: Field to map which store payment methods correspond with Bank Slip.

Forma de pagamento por paypal: Field to map which store payment methods correspond with PayPal.

Forma de pagamento por depósito bancário: Field to map which store payment methods correspond with Bank Deposit.

Forma de pagamento por transferência bancária: Field to map which store payment methods correspond with Bank Tranfer.

Fingerprint

The fingerprint module is responsible for identifying and detecting the device being used for in-store purchase.


Utiliza Google Tag Manager: Field to enable Google Tag Manager if you have it in your store.

Nome do App: Field where Fingerprint app code provided by Clearsale is populated.

Mapper

The Mapper module is responsible for mapping user browsing behavior on store pages.


App code: Field where the Mapper app code provided by Clearsale is populated.

Profiler

The Profiler module is responsible for sending the events held in the store user account as creation and modification of registration data, login/logout and password reset.


Nome do campo de cpf/cnpj: Field to map which Magento attribute is used to inform the client's CPF/CNPJ.

Total


Habilitado: Field responsible for enabling or not enabling the Clearsale module.

URL da API de Produção: Field for changing the ClearSale Production API URL, if required.

URL da API de Homologação: Field for changing the ClearSale homologation API URL, if required.

Enviar pedido editado: Field to enable shipping orders that have been edited in Magento, where the platform adds a “-1” after the order number.

Formas de pagamento: Field to choose payment methods for orders to be submitted for Clearsale review.

Cancelar automaticamente: Field to enable or not automatic order cancellation if the Cleasale review response is negative.

Situação do pedido na avaliação: Field to choose what will be the order status during Clearsale review.

Situação do pedido após aprovação: Field for choosing order status after Clearsale approval.

Situação do pedido após reprovação: Campo para escolher qual será o status do pedido após a reprovação da Clearsale.

Situação do pedido liberado manualmente: Field for choosing order status after Clearsale disapproval.

Frequência da Cron: Field to change how often the order submission cron runs for analysis.

Número de pedidos enviados por vez a cada execução: Field to change the number of orders that will be sent with each cron run.

Status Update Notification

Whenever an order status changes, Clearsale Webhook will send a notification to a URL.


This setting works as follows:

    STORE_URL + /clearsaletotal/notification/index


Example:

    http://testeshop.com.br/clearsaletotal/notification/index


Forward this URL to the integration team at integracao@clear.sale to set this URL at the Clearsale base.

Chargeback Marking

In the order screen there are 2 tabs, one of which is responsible for chargeback marking of an order already integrated and approved by Clearsale.


Example:


Status Update

The other tab of the ordering screen refers to the payment status update.

If in your business rule payment processing occurs after the order has been submitted and Clearsale's decision, You may let us know how it was completed through this service.


Example: