Introdução

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

Introduction

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

Pré-Requisitos

Instalação do Magento 2.2.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 2.2.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

Configuração

O módulo do Magento 2 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: Lojas -> 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.

Usuário Clearsale: Campo para inserir o usuário da API Clearsale.

Senha Clearsale: Campo para inserir a senha da API Clearsale.

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

Log das comunicações com API: Habilita ou não o registro de logs (Recomendável habilitar).

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.

Mapeamento das formas de pagamento


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 paypal: Campo para mapear quais meios de pagamento da loja correspondem com PayPal.

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

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

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

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.


Habilitar módulo?: Habilita ou não o funcionamento do Profiler (não impede o funcionamento do módulo Tickets).

Tickets


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

Quantidade de pedidos para criação em massa: Campo para definir a quantidade de pedidos que serão enviados para análise da Clearsale a cada execução da Cron.

Gerenciar status


Status permitidos para criação do pedido: Campo para escolher quais status de pedido do Magento serão permitidos a serem enviados para análise.

Status do pedido durante análise: Campo para escolher qual será o status do pedido do Magento quando ele está em análise na Clearsale.

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

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

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

Mapeamento dos métodos de pagamento


Métodos de pagamento permitidos para a criação do pedido: Campo para selecionar quais serão as formas de pagamento dos pedidos que irão ser enviados para a análise da Clearsale.

Configuração de Tickets


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

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

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

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

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

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

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

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

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

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

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

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.


Nome do logradouro do Evento: Campo para escolher qual atributo do Magento vai representar a o nome do endereço do evento.

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

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

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

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

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

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

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.

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.

RG ou Inscrição estadual: Campo para escolher qual atributo do Magento vai representar o documento secundário.

Nome da mãe do cliente: Campo para escolher qual atributo do Magento vai representar o nome da mãe do cliente.


Acesse a URL https://api.clearsale.com.br/docs/tickets#ticket-object caso tiver dúvidas sobre os campos.

Configurações do cron


Frequência: Campo para mudar a frequência de execução da Cron de envio dos pedidos para a análise da Clearsale (Padrão é a cada 15 minutos - Formato de Cron Linux).

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.


App code: Campo para preencher com o “App Code”, que é fornecido pela Clearsale.

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 + /clearsale_tickets/webhook/index


Exemplo:

    http://sitedaloja.com.br/clearsale_tickets/webhook/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.


Configuration

The Magento 2 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: Lojas -> Configuração -> Clearsale -> Base


Base


Ambiente: Clearsale environment where orders will be shipped.

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

Usuário Clearsale: Field to enter the Clearsale API user.

Senha Clearsale: Field to enter the Clearsale API password.

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

Log das comunicações com API?: Enables or disables logging (Recommended to enable).

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.

Payment methods mapping


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 paypal: Field to map which store payment methods correspond with PayPal.

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

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

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

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.


Habilitar módulo?: Enable or not the operation of the Profiler (does not prevent the operation of the Tickets module).

Tickets


Habilitar módulo: Enables or disables the Clearsale Tickets module.

Quantidade de pedidos para criação em massa: Field to define the number of orders that will be sent for Clearsale analysis for each Cron run.

Manage status


Status permitidos para criação do pedido: Field to choose which Magento order statuses will be allowed to be submitted for review.

Status do pedido durante análise: Field to choose what will be Magento's order status when it is under review at Clearsale.

Status do pedido após aprovação: Field to choose the status of the Magento order after Clearsale approval.

Status do pedido após aprovação manual: Field to choose what will be the Magento order status after manual approval.

Status do pedido reprovação: Field to choose what will be the status of the Magento order upon Clearsale's disapproval.

Payment methods mapping


Métodos de pagamento permitidos para a criação do pedido: Field to select which forms of payment will be made for orders that will be sent for Clearsale review.

Tickets Configuration


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

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

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

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

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

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

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

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

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

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

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

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.


Nome do logradouro do Evento: Field to choose which attribute of Magento will represent the name of the event address.

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

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

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

Sigla do Estado: Field to choose which attribute of Magento will represent the state acronym of the event address.

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

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

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.

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.

RG ou Inscrição estadual: Field to choose which Magento attribute will represent the secondary document.

Nome da mãe do cliente: Field to choose which attribute of Magento will represent the name of the customer's mother.


Visit the https://api.clearsale.com.br/docs/tickets#ticket-object URL if you have questions about the fields.

Cron settings


Frequência: Field to change how often orders are sent to Clearsale analysis (Default is every 15 minutes - Linux Cron Format).

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.


App code: Field to fill in with the “App Code”, which is provided by Clearsale.

Status Update Notification

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


This setting works as follows:

    STORE_URL + /clearsale_tickets/webhook/index


Exemplo:

    http://sitedaloja.com.br/clearsale_tickets/webhook/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.


   

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.