Integrando a OpenPix com Magento1
Plugin Pix para Magento1
Resumo
Este documento detalha passos necessários para conectar a sua plataforma de e-Commerce, baseada no Magento1, na OpenPix.
Este documento está depreciado, para acessar a documentação atualizada clique aqui
Este documento espera que você já tenha um ambiente Magento1 ativo, e uma conta criada na OpenPix Caso não tenha acesso à plataforma registre-se aqui
1. Instale o Plugin OpenPix na sua instância Magento1
Faça o download da versão .zip do plugin pelo link abaixo: Download OpenPix Magento1 Plugin - versão 1.7.1 - Versão Atual
Change Log
Extraia o conteúdo do arquivo .zip e cole dentro da pasta root
da sua loja Magento1.
Geralmente a loja root é nomeada como src
que faz referência à source. Caso sua loja seja diferente, procure pela pasta que contenha outras pastas como:
- app
- js
- lib
- skin
- var
Assim como no exemplo abaixo:
Encontrando a pasta que contenha essas citadas basta realizar o seguinte:
- Copiar os arquivos extraídos do .zip;
- Colar dentro dessa pasta
2. Configurando o Plugin Magento1
Entre em Magento1 Admin -> System > Configuration > Sales (side menu) > Payment Methods
Ao acessar Payment Methods
você irá notar o Collapsible OpenPix - Pix
- App ID Insira o AppID ou Cadastre um AppID do tipo Plugin. Crie um appID aqui
- Webhook Authorization Crie uma senha para a integração do Webhook. O Webhook é necessário para atualizar o status dos Pedidos em tempo real quando a cobrança Pix é paga.
- Lembre-se: A URL a ser utilizada no webhook deverá ser:
https://yourstore/openpix/webhook
no momento em que cadastrá-lo na plataforma OpenPix - Lembre-se: A chave que você utilizar aqui deverá ser a mesma no momento em que cadastrá-la na plataforma OpenPix.
- Crie um Webhook aqui.
- Lembre-se: A URL a ser utilizada no webhook deverá ser:
- Enabled Ativar/Desativar o plugin como método de pagamento
- Title Título do método de pagamento em sua loja Magento1
2.2 Configurando CPF/CNPJ para o Customer (opcional)
Para salvar o cpf/cnpj do customer da order na sua cobrança OpenPix é necessário que seja ativado o campo TaxVat
em sua loja Magento.
Entre em Magento1 Admin -> System > Configuration > Customers (side menu) > Customer Configuration
Em Show Tax/VAT Number
selecione o valor required:
A partir de agora os clientes terão que preencher esse campo com o CPF ou CNPJ e o mesmo será usado para salvar o cliente na plataforma OpenPix.
3. Crie o Webhook dentro da Plataforma OpenPix
Registre o Webhook que será responsável para atualizar sua loja Magento1 quando uma cobrança Pix for paga.
Para realizar o registro de um novo Webhook siga os passos abaixo:
- Va até a plataforma OpenPix e acesse: Admin -> API/Plugins -> Novo Webhook
- Utilize a mesma senha cadastrada em sua loja Magento1. O Webhook é necessário para atualizar o status dos Pedidos em tempo real quando a cobrança Pix é paga.
- A URL de Callback que deve ser utilizada no cadastro se encontra logo abaixo ao campo em que se registra a senha do webhook dentro da sua loja Magento1. O padrão é:
https://yourstore/openpix/webhook
4. Realizar Pedido com Pix
Escolha a opção de pagar o pedido usando Pix
Pague o Pix usando o app do seu banco.
Valide que o status do Pedido mudou após o pagamento
Expiração
A OpenPix ira cuidar da expiração da cobrança Pix. Entretanto, é preciso que seja configurado em sua loja magento a expiração da order pois o mesmo cuidará de todo o processo.
Entretanto, o magento1 nao possui uma solução nativa para a mesma.
Indicamos que a expiração/cancelamento da order no magento1 seja feito utilizando uma lib terceira para ajuda.
Uma vez tendo a lib terceira indicamos que seja seguido uma configuração semelhante abaixo:
- tempo de expiração da cobrança OpenPix: 15 minutos
- coloque os mesmos 15 minutos dentro da sua loja Magento.
No magento você pode utilizar a lib abaixo ou alguma de sua preferência:
Atualizando o plugin
Indicamos aos clientes OpenPix estar sempre atualizados com a última versão do plugin. Você pode identificar a mesma no step de instalação.
Caso seu plugin esteja desatualizado basta seguir os passos do mesmo step de instalação e atualizar os arquivos do plugin em seu ecommerce.
Debug
Para debugar o plugin OpenPix temos dois arquivos e você encontra ambos dentro de var/log
:
openpix_exception.log
: arquivo que concentra logs referentes ao processo de criação de um novo pedido Magento e consequentemente a charge no lado da OpenPixopenpix_webhooks.log
: arquivo que concentra logs referentes ao processo de pagamento de um pedido. O webhook é chamado quando identificamos um novo Pix em sua conta e o mesmo trata de atualizar o status da order em sua loja Magento.