Manual de Integração Magento TrayCheckout Versão 1.0
CONTEÚDO 1. MÓDULO DE INTEGRAÇÃO MAGENTO E TRAYCHECKOUT... 1 1.1. Instalação do Método de pagamento TrayCheckout (com chave)... 1 1.2. Instalação do Método de pagamento TrayCheckout (com pacote )... 2 1.3. Configurar Método de pagamento TrayCheckout... 4 1.4. Retorno dos status de transação... 5 Suporte a Desenvolvedores: integracao@traycheckout.com.br www.traycheckout.com.br
1. MÓDULO DE INTEGRAÇÃO MAGENTO E TRAYCHECKOUT Para disponibilizar o TrayCheckout como facilitador de pagamento na plataforma Magento, basta acessar o Magento Connect Manager de sua loja e instalar o módulo disponível no repositório Magento Connect ou baixar o pacote disponível no site institucional da Tray. 1.1. Instalação do Método de pagamento TrayCheckout (com chave) Para instalar módulo é necessário ter a extension key do site do Magento Connect. A extension key do TrayCheckout pode ser resgatada através do link: http://www.magentocommerce.com/magento-connect/catalog/product/view/id/16291/ Acesse o Magento Connect Manager de sua loja Magento (Sistema > Conexão Magento > Gerenciador de Conexão Magento), e cole a extension key do TrayCheckout no campo correspondente da área marcada em vermelho, em seguida clique em Install. 1
Após a instalação do pacote, será exibido um log semelhante à imagem abaixo: Clique no botão Refresh e verifique se o módulo Tray_CheckoutRedir é listado nos módulos instalados, conforme abaixo: O próximo passo é configurar o módulo (ver 8.1.3). Clique em Return to Admin para voltar à área administrativa de sua loja virtual. 1.2. Instalação do Método de pagamento TrayCheckout (com pacote ) Para instalar o módulo é necessário baixar o arquivo (Tray_CheckoutRedir-x.x.x.x.tgz) através da página a seguir: http://static.traycheckout.com.br/integracao/magento/ Acesse o Magento Connect Manager de sua loja Magento (Sistema > Conexão Magento > Gerenciador de Conexão Magento) e clique no botão Selecionar arquivo da opção Upload package file, conforme imagem abaixo. Selecione o pacote do TrayCheckout baixado anteriormente, em seguida clique em Upload. 2
Após a instalação do pacote, será exibido um log semelhante à imagem abaixo: 3
Clique no botão Refresh e verifique se o módulo Tray_CheckoutRedir é listado nos módulos instalados, conforme abaixo: O próximo passo é configurar o módulo. Clique em Return to Admin para voltar à área administrativa de sua loja virtual. 1.3. Configurar Método de pagamento TrayCheckout Acessar menu Sistema > Configuração, no menu do lateral esquerdo procure por Métodos de Pagamento (faz parte do sub-menu Vendas). Ao clicar no link, será listado todos os métodos de pagamento disponíveis, procure pela aba TrayCheckout para habilitar e configurar o método de pagamento. Opções de configuração Tray Checkout: Ativado: opção para habilitar o TrayCheckout na finalização de compra; Título: título que aparecerá para seu cliente na hora de escolher a forma de pagamento; Status dos Novos Pedidos: status de cada novo pedido ao ser enviado para a Tray; Modelo de Endereço Personalizado: caso esteja em Não (instalação padrão) será utilizado dois campos como endereço e no envio para o TrayCheckout, será convertido para os campos correspondentes (rua, número, complemento e bairro). Ao habilitar este campo, será necessário existir quatro campos no checkout da loja para identificar endereço, sendo eles respectivamente: rua, número, complemento e bairro; Token: chave gerada no seu painel de administração da Tray; Gerar Fatura automaticamente para pedidos com produtos virtuais: caso esteja em "Sim", os pedidos que contiverem ao menos um (1) produto virtual serão automaticamente marcados como "concluídos", após o recebimento automático do pagamento. Isto se dá em função da não existência da etapa de "Envio" para estes 4
produtos. Prefixo do Pedido: campo utilizado para concatenar com o número do pedido da loja ao integrar com a Tray; Ordem de exibição: ordem de exibição, caso exista mais de um método de pagamento; Ambiente de Teste (Sandbox): ambiente utilizado para que a loja possa realizar testes de integração - muita atenção para não manter este ambiente habilitado quando a loja estiver efetivamente vendendo; Tipo de exibição: existem três opções de carregamento do TrayCheckout, modal e iframe que abrem dentro da loja e Redirect que abre uma nova aba/janela. Atenção: Após salvar as configurações, acesse o menu Sistema > Gerenciador de Cache e limpe o cache de configuração (selecione "Atualizar" em Todo cache e deixe o item "Configuração" marcado). Salve as configurações e verifique se o módulo já está disponível no seu site. 1.4. Retorno dos status de transação Sempre que é criada uma transação pelo módulo do TrayCheckout no Magento, é enviada a URL responsável por receber automaticamente todas as notificações de alterações de status das transações do sistema. Assim, a cada alteração de status da transação, o TrayCheckout notifica a loja que atualiza o status dos pedidos. Por exemplo, um pedido é considerado como aprovado quando estiver com status de Processando (Processing) no Magento. 5