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

Instalação do Magento 1.9.0 ou superior.

Instalar o plugin conforme o produto contratado (Tickets).


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

Prerequisites

Magento 1.9.0 or higher installation.

Install the plugin according to the contracted product (Tickets).


Click here to download plugin installation file.

Instalação

Basta descompactar o conteúdo zipado do módulo dentro da pasta do projeto.


Para ter certeza de que o Magento está reconhecendo o módulo, vá ao terminal na pasta do seu projeto e rode o comando:

bin/magento module:status


Para habilitar o módulo, os seguintes comandos devem ser executados no terminal:

php bin/magento module:enable Clearsale_Base Clearsale_Fingerprint Clearsale_MapperClearsale_Profiler Clearsale_Tickets --clear-static-content

php bin/magento setup:upgrade

Installation

Only unzip the zipped contents of the module into the project folder.


To make sure that Magento is recognizing the module, go to the terminal in your project folder and run the command:

bin/magento module:status


To enable the module, the following commands must be executed at the terminal:

php bin/magento module:enable Clearsale_Base Clearsale_Fingerprint Clearsale_MapperClearsale_Profiler Clearsale_Tickets --clear-static-content

php bin/magento setup:upgrade

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 produto Tickets é composto por 5 sub-módulos. São eles:


    Base

    Profiler

    Tickets

    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.

Cód Integração ClearSale Homologação/Produção: Nesse campo você deverá inserir o nome de usuário de integração da loja fornecido pela Clearsale.

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

Habilitar Log: Habilita 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


Atributo de rua: Campo para mapear qual campo é utilizado para informar a Rua do endereço em seu checkout.

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

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

Atributos de complemento: Campo para mapear qual campo é utilizado para informar o Complemento 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.


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

Nome do App: Campo para preencher com o “App Name”, que é 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.


Código da Aplicação: Campo para preencher com o “App Code”, que é fornecido pela Clearsale.

Tickets


Habilitar: Habilita ou não o módulo Clearsale Tickets.

Cancelar pedido após ser rejeitada: Campo para escolher se o pedido vai ser cancelado no Magento após ele ser reprovado pela análise da Clearsale.

Métodos de pagamento: Campo para escolher quais meios de pagamento o módulo irá permitir ser realizada a análise.

Status das ordens a serem aprovadas: Campo para escolher qual será o status do pedido enquanto está na fila para ser aprovado pela Clearsale.

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

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


Nome do método de pagamento por cartão de crédito: Campo para escolher qual meio de pagamento da loja representa a forma de pagamento Cartão de crédito.


Nome do método de pagamento por Boleto: Campo para escolher qual meio de pagamento da loja representa a forma de pagamento por Boleto.


Nome do método de pagamento por Débito Bancário: Campo para escolher qual meio de pagamento da loja representa a forma de pagamento Débito bancário.


Nome do método de pagamento por Débito por dinheiro: Campo para escolher qual meio de pagamento da loja representa a forma de pagamento Débito por dinheiro.


Nome do método de pagamento por Débito por cheque: Campo para escolher qual meio de pagamento da loja representa a forma de pagamento Débito por cheque.


Nome do método de pagamento por Transferência: Campo para escolher qual meio de pagamento da loja representa a forma de pagamento Transferência.


Nome do método de pagamento por Sedex a cobrar: Campo para escolher qual meio de pagamento da loja representa a forma de pagamento Sedex a cobrar.


Nome do método de pagamento por Cheque: Campo para escolher qual meio de pagamento da loja representa a forma de pagamento Cheque.


Nome do método de pagamento por Dinheiro: Campo para escolher qual meio de pagamento da loja representa a forma de pagamento Dinheiro.


Nome do método de pagamento por Financiamento: Campo para escolher qual meio de pagamento da loja representa a forma de pagamento Financiamento.


Nome do método de pagamento por Cupom: Campo para escolher qual meio de pagamento da loja representa a forma de pagamento Cupom.


Nome do método de pagamento por Fatura: Campo para escolher qual meio de pagamento da loja representa a forma de pagamento Fatura.


Nome do método de pagamento por Multicheque: Campo para escolher qual meio de pagamento da loja representa a forma de pagamento Multicheque.


Nome do método de pagamento por Vale: Campo para escolher qual meio de pagamento da loja representa a forma de pagamento Vale.


Nome do método de pagamento por Débito parcelado: Campo para escolher qual meio de pagamento da loja representa a forma de pagamento Débito parcelado.


Nome do método de pagamento por Vale desconto: Campo para escolher qual meio de pagamento da loja representa a forma de pagamento Vale desconto.


Ticket - Taxa de conveniência: Campo para escolher qual atributo do Magento vai representar a taxa de conveniência.

Ticket - Quantidade de ingressos com valor integral: Campo para escolher qual atributo do Magento vai representar a quantidade de ingressos com valor integral.

Ticket - Quantidade de ingresso com desconto (meia entrada): Campo para escolher qual atributo do Magento vai representar a quantidade de ingresso com desconto.

Ticket - Lote do ingresso: : Campo para escolher qual atributo do Magento vai representar o lote do ingresso.

Ticket - Ingresso virtual: Campo para escolher qual atributo do Magento vai representar o atributo ‘Ingresso virtual’ da Clearsale.


Evento - Código do Evento: Campo para escolher qual atributo do Magento vai representar o código do Evento.

Evento - Nome do Evento: Campo para escolher qual atributo do Magento vai representar o nome do Evento.

Evento - Local do Evento: Campo para escolher qual atributo do Magento vai representar o local do Evento.

Evento - Data do Evento: Campo para escolher qual atributo do Magento vai representar a data do Evento.

Evento - Gênero do Evento: Campo para escolher qual atributo do Magento vai representar o gênero do Evento.

Evento - Quantidade de ingressos à venda: Campo para escolher qual atributo do Magento vai representar a quantidade de ingressos à venda.

Evento - Quantidade de vezes que o evento será realizado na casa: Campo para escolher qual atributo do Magento vai representar o atributo ‘Quantidade de vezes que o evento será realizado na casa’, da Clearsale.


Endereço do Evento - Rua: Campo para escolher qual atributo do Magento vai representar a o nome do endereço do evento.

Endereço do Evento - Número: Campo para escolher qual atributo do Magento vai representar o número do endereço do evento.

Endereço do Evento - Bairro: Campo para escolher qual atributo do Magento vai representar o bairro do endereço do evento.

Endereço do Evento - Cidade: Campo para escolher qual atributo do Magento vai representar a cidade do endereço do evento.

Endereço do Evento - Estado: Campo para escolher qual atributo do Magento vai representar a sigla do Estado do endereço do evento.

Endereço do Evento - País: Campo para escolher qual atributo do Magento vai representar o país do endereço do evento.

Endereço do Evento - CEP: Campo para escolher qual atributo do Magento vai representar o CEP do endereço do evento.


Pessoa - Nome (Nome da Pessoa que comparecerá ao evento): Campo para escolher qual atributo do Magento vai representar o atributo ‘Nome da Pessoa que comparecerá ao evento’, da Clearsale.

Pessoa - Documento de identificação (Documento de identificação da pessoa que comparecerá ao evento): Campo para escolher qual atributo do Magento vai representar o atributo ‘Documento de identificação da pessoa que comparecerá ao evento’, da Clearsale.

Cliente - Documento Secundário (RG ou Inscrição estadual): Campo para escolher qual atributo do Magento vai representar o documento secundário.

Cliente - Nome da Mãe (Nome da mãe do cliente): Campo para escolher qual atributo do Magento vai representar o nome da mãe do cliente.

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: Field to map which Magento attribute is used to inform the client's CPF / CNPJ.

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.


    URL_DA_LOJA + /clearsaleTickets/index/notificate


Exemplo:

    http://sitedaloja.com.br/clearsaleTickets/index/notificate


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 Tickets product consists of 5 submodules. Are they:


    Base

    Profiler

    Tickets

    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 "Producão" to ship actual orders placed in your store.

Cód Integração ClearSale Homologação/Produção: In this field you must enter the store integration username provided by Clearsale.

Senha de integração de Homologação/Produção: In this field you must enter the integration password provided by Clearsale.

Habilitar Log: Enables or disables logging (Recommended to enable).

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

Address Mapping


Atributo de rua: To map which field is used to inform the address of your checkout address.

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

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

Atributos de complemento: To map which field is used to enter the address complement in 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.


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

Nome do App: Field to fill in with the “App Name”, which is provided by Clearsale.

Mapper

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


Código da Aplicação: Field to fill in with the “App Code”, which is provided by Clearsale.

Tickets


Habilitar: Enables or disables the Clearsale Tickets module.

Cancelar pedido após ser rejeitada: Field to choose whether the order will be canceled on Magento after it has been disapproved by Clearsale review.

Métodos de pagamento: Field to choose which means of payment the module will allow to perform the analysis.

Status das ordens a serem aprovadas: Field to choose what will be the order status while queuing to be approved by Clearsale.

Status do pedido após ser aprovado: Field to choose what will be the order status after Clearsale approval.

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

Nome do método de pagamento por cartão de crédito: Field to choose which store payment method represents the payment method Credit Card.


Nome do método de pagamento por Boleto: Field to choose which store payment method represents the form of payment by Boleto.


Nome do método de pagamento por Débito Bancário: Field for choosing which store payment method represents the payment method Bank debit.


Nome do método de pagamento por Débito por dinheiro: Field to choose which store payment method represents the payment method Debit for cash.


Nome do método de pagamento por Débito por cheque: Field to choose which store payment method represents the form of payment Debit by check.


Nome do método de pagamento por Transferência: Field for choosing which store payment method represents the Transfer payment method.


Nome do método de pagamento por Sedex a cobrar: Field to choose which store payment method represents the Sedex payment method to charge.


Nome do método de pagamento por Cheque: Field to choose which store payment method represents the payment method Check.


Nome do método de pagamento por Dinheiro: Field to choose which store payment method represents the payment method Money.


Nome do método de pagamento por Financiamento: Field to choose which store payment method represents the payment method Funding.


Nome do método de pagamento por Cupom: Field to choose which store payment method represents the Coupon payment method.


Nome do método de pagamento por Fatura: Field to choose which store payment method represents the Invoice payment method.


Nome do método de pagamento por Multicheque: Field to choose which store payment method represents the Multicheque payment method.


Nome do método de pagamento por Vale: Field for choosing which store payment method represents the Vale payment method.


Nome do método de pagamento por Débito parcelado: Field to choose which store payment method represents the payment method Debit in installments.


Nome do método de pagamento por Vale desconto: Field to choose which store payment method represents the payment method Discount voucher.


Ticket - Taxa de conveniência: Field to choose which Magento attribute will represent the convenience rate.

Ticket - Quantidade de ingressos com valor integral: Field to choose which Magento attribute will represent the amount of full value tickets.

Ticket - Quantidade de ingresso com desconto (meia entrada): Field for choosing which Magento attribute will represent the discounted ticket amount.

Ticket - Lote do ingresso: : Field to choose which attribute of Magento will represent the ticket lot.

Ticket - Ingresso virtual: Field to choose which Magento attribute will represent Clearsale's 'Virtual Ticket' attribute.


Evento - Código do Evento: Field to choose which attribute of Magento will represent the event code.

Evento - Nome do Evento: Field to choose which attribute of Magento will represent the name of the Event.

Evento - Local do Evento: Field to choose which attribute of Magento will represent the location of the Event.

Evento - Data do Evento: Field to choose which attribute of Magento will represent the date of the Event.

Evento - Gênero do Evento: Field to choose which attribute of Magento will represent the genre of the Event.

Evento - Quantidade de ingressos à venda: Field to choose which attribute of Magento will represent the number of tickets for sale.

Evento - Quantidade de vezes que o evento será realizado na casa: Field to choose which attribute of Magento will represent the attribute ‘Number of times the event will be held in the house’ by Clearsale.


Endereço do Evento - Rua: Field to choose which attribute of Magento will represent the name of the event address.

Endereço do Evento - Número: Field to choose which attribute of Magento will represent the event address number.

Endereço do Evento - Bairro: Field to choose which attribute of Magento will represent the neighborhood of the event address.

Endereço do Evento - Cidade: Field to choose which attribute of Magento will represent the city of the event address.

Endereço do Evento - Estado: Field to choose which attribute of Magento will represent the state acronym of the event address.

Endereço do Evento - País: Field to choose which attribute of Magento will represent the country of the event address.

Endereço do Evento - CEP: Field to choose which Magento attribute will represent the zip code of the event address.


Pessoa - Nome (Nome da Pessoa que comparecerá ao evento): Field to choose which Magento attribute will represent the Clearsale's 'Name of the Person attending the event' attribute.

Pessoa - Documento de identificação (Documento de identificação da pessoa que comparecerá ao evento): Field to select which Magento attribute will represent the Clearsale's 'Event Attendee Identification Document' attribute.

Cliente - Documento Secundário (RG ou Inscrição estadual): Field to choose which attribute of Magento will represent the secondary document.

Cliente - Nome da Mãe (Nome da mãe do cliente): Field to choose which attribute of Magento will represent the name of the client's mother.

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.

Status Update Notification

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


    STORE_URL + /clearsaleTickets/index/notificate


Exemplo:

    http://sitedaloja.com.br/clearsaleTickets/index/notificate


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.



Exemplo:

   

Status Update

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

If in your business rule payment processing occurs after order submission and decision Clearsale, you may let us know how it was completed through this service.


Exemplo: