Instalando o módulo

Como usar o Asaas no Magento

Módulo de integração Magento/Asaas

O módulo oficial do Asaas para Magento permite integrar a loja ao Asaas para processamento de pagamentos via Pix, boleto bancário e cartão de crédito.

Após a instalação e configuração, os pedidos criados no Magento passam a utilizar a conta Asaas configurada para processamento dos pagamentos.

Quando utilizar o módulo Asaas

O módulo oficial do Asaas para Magento é indicado para lojas que desejam utilizar o Asaas como gateway de pagamentos sem necessidade de desenvolver uma integração personalizada.

A instalação é recomendada para operações que desejam:

receber pagamentos via Pix, boleto bancário e cartão de crédito;
disponibilizar parcelamento no cartão de crédito;
centralizar o processamento financeiro na conta Asaas;
utilizar uma integração oficial compatível com Magento;
automatizar a atualização dos pedidos através da comunicação entre Magento e Asaas.

O módulo pode ser utilizado tanto em novas lojas quanto em operações já existentes que desejam substituir ou adicionar um novo meio de pagamento.

O que o módulo faz

Após a instalação e configuração, o módulo permite:

processar pagamentos através do Asaas;
disponibilizar Pix, boleto e cartão de crédito no checkout;
atualizar automaticamente os pedidos conforme os eventos financeiros;
utilizar parcelamento no cartão de crédito;
enviar notificações de pagamento aos compradores, quando habilitadas;
sincronizar as informações entre Magento e Asaas.

Dependências para utilização

Antes de iniciar a instalação, é necessário que:

exista uma conta Asaas ativa;
a API Key da conta esteja disponível;
a loja utilize Magento 2.3.x ou 2.4.x;
o ambiente possua PHP 7.1.x ou superior;
seja possível instalar módulos através do Composer ou do diretório da aplicação;
o ambiente possua permissões adequadas para execução dos comandos do Magento.

📘
Importante
Recomenda-se realizar a instalação inicialmente em ambiente de homologação e somente depois replicar as alterações em produção.

Comportamentos importantes

Após a instalação, o módulo ainda precisa ser configurado no painel administrativo do Magento.

As configurações realizadas posteriormente irão definir:

ambiente de operação (produção ou desenvolvimento);
credenciais de integração;
formas de pagamento habilitadas;
parcelamento do cartão de crédito;
validade do boleto;
validade do Pix;
webhooks responsáveis pela atualização dos pedidos.

Sem essas configurações, o módulo não estará apto para processar pagamentos.

Impactos operacionais

A instalação do módulo altera o fluxo financeiro da loja e passa a depender da comunicação entre Magento e Asaas.

Por esse motivo, recomenda-se:

manter backups atualizados;
testar o fluxo completo antes da publicação em produção;
validar a criação e confirmação de pedidos;
revisar as configurações após atualizações do Magento;
monitorar o comportamento dos pagamentos nas primeiras vendas.

Exemplos de validação após a instalação

Após concluir a instalação, recomenda-se validar o seguinte fluxo:

Instalar módulo
↓
Configurar API Key
↓
Habilitar formas de pagamento
↓
Realizar compra de teste
↓
Confirmar pagamento
↓
Validar atualização automática do pedido

Instalação

Recomendamos que você possua um ambiente de testes para validar as alterações e atualizações antes de atualizar sua loja em produção. Também que seja feito um backup com todas as informações antes de executar qualquer procedimento de atualização/instalação.

Versões Compatíveis:

2.3.x
2.4.x

Pré requisito:

Requer a que o PHP esteja no mínimo na versão 7.1.X.

📘
Através do Adobe Market

Você poderá realizar a compra do módulo (totalmente gratuito) através da loja oficial de aplicativos da Adobe.

Para isso, basta acessar o link a seguir -> https://commercemarketplace.adobe.com/asaas-module-magento2.html

Uma vez que o módulo tenha sido incluído no carrinho e a compra tenha sido executada, você poderá realizar a instalação seguindo as instruções da página de instalação fornecida pela Adobe.

Para informações detalhadas, acesse:

https://experienceleague.adobe.com/pt-br/docs/commerce-operations/installation-guide/tutorials/extensions

📘
Através do repositório Asaas ($git clone)

Realize o download do módulo, clonando esse repositório, e siga os seguintes passos de acordo com a forma que sua loja foi instalada:

Instalar usando o Composer

Instale via packagist

composer require asaas/module-magento2
Neste momento, podem ser solicitadas suas credenciais de autenticação do Magento. Caso tenha alguma dúvida, há uma descrição de como proceder na documentação oficial.

Execute os comandos:

php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

php bin/magento setup:static-content:deploy pt_BR

de acordo com as configurações da sua loja.

📘
Instalar usando o Github

Caso sua loja tenha sido criada por meio do clone ou download do projeto Magento, siga os seguintes passos:

Extraia o conteúdo do download ZIP do repositório oficial e mova o diretório para:

app/code/Asaas/Magento2

Verifique se os diretórios estão corretamente organizados.
Execute:

bin/magento setup:upgrade

Execute:

bin/magento setup:di:compile

Execute:

bin/magento setup:static-content:deploy -f

Execute:

bin/magento cache:clean

Erros comuns

API Key inválida

Pode ocorrer quando a credencial configurada pertence a outra conta ou foi copiada incorretamente.

Módulo não aparece no Magento

Pode indicar falha durante a instalação ou necessidade de executar novamente os comandos de atualização e limpeza de cache.

Pedido não é atualizado automaticamente

Pode ocorrer devido à ausência ou configuração incorreta do webhook.

Problemas após atualização do Magento

Recomenda-se validar a compatibilidade do módulo e executar testes antes de aplicar atualizações em produção.

Próximos passos

Após concluir a instalação do módulo, recomenda-se prosseguir para:

Configurações iniciais do Magento;
Configuração da API Key do Asaas;
FAQ da integração Magento + Asaas.