MANUAL MÓDULO CHECKOUT CIELO (VERSÃO 1.0.0) QUERY COMMERCE

MANUAL MÓDULO CHECKOUT CIELO (VERSÃO 1.0.0) QUERY COMMERCE

Introdução Esse manual fornecerá as informações necessárias para a realização da integração de sua loja em Magento com o sistema de pagamento da Checkout Cielo. Essa integração permite o recebimento de transações seja via débito ou crédito com a maioria das bandeiras presentes no mercado. O Checkout Cielo é uma solução de checkout projetada para aumentar a conversão, simplificar o processo de compra e reduzir fraudes e custos operacionais. Integração Cielo Este tópico tem por finalidade instruir os utilizadores do Módulo de Integração do Magento com a API Cielo Checkout a realizar a instalação corretamente, identificando possíveis erros e problemas que possam surgir neste processo. As instruções irão se dividir conforme a listagem que se segue: 1. Instalando o módulo a. Cópia dos arquivos b. Permissão de leitura c. Limpeza do cache 2. Verificando se o módulo foi instalado no sistema a. Listagem de módulos instalados b. Menu de navegação e configurações c. Tabelas no banco de dados 3. Possíveis problemas 1) Instalando o módulo a) Copia dos arquivos O primeiro passo a ser realizado é a cópia dos arquivos do módulo para a sua aplicação. Os arquivos estão organizados e estruturados respeitando a hierarquia de pastas do Magento, portanto basta copiar os arquivos do módulo para a pasta raiz da instalação do Magento. Por exemplo, se o Magento está instalado na pasta /var/www do seu servidor, basta copiar os arquivos do módulo para esta pasta, seja por meio de acesso FTP, acesso SFTP, linha de comando ou mesmo interface gráfica.

b) Permissão de Leitura Confira se os arquivos que você copiou possuem permissão de leitura do usuário utilizado pelo seu servidor HTTP, para evitar problemas na execução do módulo. Recomenda-se que sejam aplicadas aos arquivos do módulo as permissões designadas para os demais arquivos do Magento. c) Limpeza de Cache Uma vez que seus arquivos do módulo foram instalados e possuem as permissões corretas, limpe o cache do Magento para que o módulo seja instalado e todos os seus menus apareçam na navegação da administração. Caso você esteja logado na administração antes de iniciar o processo de instalação, recomendamos que você faça logout e entre novamente na administração da sua loja, pois alguns menus da configuração exigem esta renovação de sessão. Para realizar a limpeza do cache acesse no menu da administração Sistema Gerenciamento Cache. Caso possua caches adicionais, como por exemplo, os caches de opcode do PHP, não se esqueça de realizar a renovação dos mesmos.

2) Verificando se o módulo foi instalado no sistema a) Listagem de módulo instalados A primeira verificação a ser realizada para saber se seu módulo foi corretamente instalado é ir à listagem de módulos na administração do Magento. Navegue para Sistema Configurações Avançado. Nesta tela, expanda a listagem de módulos instalados e configura se o módulo de integração está instalado. Procure pela entrada Query CieloCheckout, conforme mostra a figura abaixo: Caso não encontre o módulo listado, averigue se algum dos dados passos anteriores foi realizado incorretamente e, caso persista o erro, entre em contato com o suporte. b) Menu de configuração Neste momento, o menu de configuração do módulo irá aparecer na administração da sua loja Magento em Sistema Configurações Vendas Formas de Pagamento, conforme mostrado nas figuras abaixo:

Navegue pela página dos menus do módulo em Cielo Checkout Query Commerce para assegurar que os funcionamentos dos mesmos estejam corretos. c) Possíveis problemas Caso haja algum problema na instalação do módulo, releia com atenção cada um dos passos a serem realizados e averigue se há entradas no log da sua loja. Para ativar o log da loja virtual, navegue até Sistema Configuração Desenvolvedor Configurações de Log e ative-o. Os arquivos de log se encontram na pasta /{instalação_magento}/var/log, sendo {instalação_magento} a pasta raiz da sua instalação do Magento. Em caso de erro do tipo Not valid template, basta entrar na pasta app do módulo, Design, frontend, default e transferir manualmente as pastas layout e template que se encontra no mesmo caminho descrito anteriormente. Persistindo os problemas, entre em contato com o suporte para a solução de problemas.

Configuração do módulo As configurações do módulo podem ser acessadas através do Sistema Configuração Vendas Formas de Pagamento. Após clicar sobre Formas de Pagamento uma nova página será carregada. Nesta página é possível visualizar todas as formas de pagamento, incluindo a do módulo da Cielo Checkout. A ilustração abaixo mostra a interface de configuração. A seguir segue uma descrição completa sobre cada um dos campos da configuração. Ativo: habilita e desabilita o uso do módulo Título: campo responsável por nomear como irá aparecer o título do método de pagamento para o cliente ID do Vendedor: correspondente ao ID do lojista com a Cielo(Merchant_id). Soft. Descriptor: corresponde a uma mensagem que aparecerá na fatura do cliente. Fraude: define se a transação será analisada contra fraudes Novo Status do Pedido: Status no qual o pedido se encontrará logo após o cliente ter o realizado. Buscar na loja: especifica a modalidade de frete pela caixa de seleção Tipo de Produto: especifica a modalidade do produto pela caixa de seleção

Possui desconto? : especifica se terá ou no desconto Tipo de desconto: especifica se a modalidade de desconto será dada em valor fixo (centavos) ou percentual (número inteiro) Desconto para boleto bancário: especifica valor de desconto para o boleto Desconto para débito: especifica valor de desconto para o débito Fatura automática: habilita e desabilita o faturamento automático do pedido no Magento. Quando habilitada qualquer compra capturada na administração do Checkout no ambiente da Cielo será automaticamente faturada no Magento assim que a mudança de status for enviada. Cancelamento automático: habilita e desabilita o cancelamento automático de compras. Quando habilitado qualquer compra que foi cancelada na administração do Checkout no ambiente da Cielo será cancelada no Magento assim que a mudança de status for enviada. Permite pedido IPs: IPs que possui permissão a realizar requisição ao módulo CPF do cliente: especifica o valor CPF do campo pela caixa de seleção Telefone do cliente: especifica o valor Telefone do campo pela caixa de seleção País do cliente: especifica o valor País do campo pela caixa de seleção Estado do cliente: especifica o valor Estado do campo pela caixa de seleção Cidade do cliente: especifica o valor Cidade do campo pela caixa de seleção Bairro do cliente: especifica o valor Bairro do campo pela caixa de seleção Rua do cliente: especifica o valor Rua do campo pela caixa de seleção Número da rua do cliente: especifica o valor Número do campo pela caixa de seleção Complemento do cliente: especifica o valor Complemento do campo pela caixa de seleção CEP do cliente: especifica o valor CEP do campo pela caixa de seleção Verificar: O botão Verificar tem por objetivo realizar um teste que assegura se todos os dados cadastrais dos clientes, selecionados anteriormente, serão enviados para a Cielo corretamente. A imagem abaixo mostra o funcionamento do botão Verificar:

Após clicar sobre o botão Verifica, será necessário à escolha de um cliente e em seguida clicar no botão Testar. O resultado de tais ações mostra o campo e os respectivos valores correspondentes ao cliente selecionado anteriormente. Com os dados desse resultado será possível verificar se os dados foram alocados corretamente na configuração, como mostra a imagem abaixo: Depois de configurado no Magento devemos configurar o Cielo Checkout na administração da Cielo. Para isso você deve acessar http://www.cielo.com.br/ecommerce e entrar com seus dados, depois de logado você deve ir a VENDAS ONLINE -> CHECKOUT CIELO, uma área administrativa aparecerá e você deve ir a CONFIGURAÇÕES -> CONFIGURAÇÕES DA LOJA e preencher os campos URL de Retorno, URL de Notificação e URL de Mudança de Status. Os campos devem ser preenchidos com os valores http://www.minhaloja.com.br/querycielocheckout/payment/index, http://www.minhaloja.com.br/querycielocheckout/payment/notification e http://www.minhaloja.com.br/querycielocheckout/payment/status sendo que o www.minhaloja.com.br deve ser substituído pelo endereço da sua loja.

Funcionamento Depois de configurado o módulo corretamente, o mesmo já está apto para ser utilizado pelos clientes em suas compras futuras. A tela a seguir mostra como o cliente ira visualizar quando finalizar seu pedido de compra. Depois de realizado todo o procedimento de compra do pedido e o cliente ter selecionado Query Cielo Checkout em Informação de Pagamento, o cliente será automaticamente redirecionado a uma página segura da Cielo para poder informar os dados referentes ao pagamento. A imagem abaixo mostra a página que o cliente será redirecionado.

Em Forma de Pagamento o cliente deverá selecionar entre o meio de pagamento Cartão de Crédito ou Cartão de Débito. Em seguida deverá selecionar a bandeira do cartão e preencher o Número do Cartão, a Data de validade, o Nome do Titular, Código de segurança e a quantidade de vezes que se deseja parcelar a compra. Ao clicar no botão Concluir Pagamento, uma nova página da loja será carregada para o cliente, juntamente com os dados da compra que o mesmo acabou de realizar.

Caso a opção de Fatura automática estiver habilitado na configuração da loja, o cliente receberá sua fatura por email automaticamente. Caso essa opção não estiver habilitada, o lojista terá que faturar suas compras manualmente pela administração do Magento. O mesmo se aplica para a configuração Cancelamento automático. Caso a mesma esteja habilitada, todos os cancelamentos realizados pelos clientes serão capturados automaticamente juntamente com o estorno da transação caso seja necessário. Caso o Cancelamento automático não estiver habilitado, a realização de estorno/cancelamento da transação deve ser utilizado o reembolso do Magento, através da interface é possível criar reembolsos parciais ou totais o que gera cancelamento parcial ou total na Cielo, fazendo com que o lojista tenha flexibilidade para cancelar apenas alguns itens de uma compra. Para ter acesso aos pedidos realizados, basta ir através do menu em Venda Pedidos e clicar ao pedido correspondente que se deseja visualizar. Feito isso uma nova tela como a imagem abaixo irá carregar. Em Informações de Pagamento encontram-se todas as informações referente do pedido. O lojista precisa administrar suas compras pelo painel administrativo do Checkout Cielo e é através dele que se faz a captura de pedidos e cancelamentos além de ter a possibilidade de enviar notificações de forma de pagamento e status do pedido para a loja a virtual. Todo o processo de manter os pedidos do Checkout Cielo sincronizados com a loja é feito manualmente e é realizado utilizando os botões em destaque abaixo.

O botão Forma de pagamento quando clicado faz uma requisição para loja através da URL de Notificação e atualizam os dados da compra, ele pode ser utilizado toda vez que a comunicação entre o magento e a Cielo sofrer algum problema e o lojista necessitar atualizar os dados da compra na loja. O botão Informações de pagamento envia uma requisição para loja através da URL de mudança de status e deve ser utilizada toda vez que o lojista fizer alguma ação como captura ou cancelamento do pedido. Os botões Capturar e Cancelar devem sempre ser utilizados em conjunto com o uso botão Informações de pagamento fazendo com que o pedido fique sincronizado com a loja. FAQ Perguntas frequentes Como devo proceder em caso de erro no log do tipo Not valid template? Nessa situação basta realizar a transferência das pastas layout e template manualmente dentro da hierarquia padrão do Magento dentro de sua loja. Tais pastas se encontram em app, Design frontend, rwd e default. Feito isso sua integração com o módulo da Cielo Checkout deverá funcionar como esperado. Onde está o botão Cancelar na Cielo? O botão Cancelar na Cielo foi substituído pela função padrão do Magento de criação de reembolsos. Agora sempre que criado um reembolso, total ou parcial, é criada uma transação de cancelamento na Cielo com o valor reembolsado.