-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(magento2): add magento2 docs and cleanup magento1 (#445)
* feat(magento2): add magento2 docs and cleanup magento1 * feat(docs): revamp docs of oneclick * feat(docs): revamp docs of oneclick * feat(docs): little change
- Loading branch information
1 parent
d218d91
commit d795e5c
Showing
14 changed files
with
311 additions
and
125 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
[OpenPix For Magento2](https://marketplace.magento.com/openpix-pix.html) | ||
|
||
![Banner](../__assets__/magento2-banner.png) | ||
![Install](../__assets__/magento2-marketplace-search.png) | ||
|
||
[Download OpenPix Magento2 Plugin - versão 2.3.0](pathname:///magento2/openpix_pix.2.3.0.zip) - Versão Atual |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,128 @@ | ||
--- | ||
id: magento2-oneclick | ||
title: Integrando a OpenPix com Magento2 Em Um Clique | ||
sidebar_label: Magento2 OpenPix 1-Click | ||
sidebar_position: 0 | ||
tags: | ||
- magento2 | ||
- ecommerce | ||
--- | ||
|
||
import Magento2Download from './__components__/magento2-install.mdx' | ||
|
||
### Plugin Pix para Magento2 | ||
|
||
## Resumo | ||
|
||
Este documento detalha passos necessários para conectar a sua plataforma de e-Commerce, baseada no Magento2, na OpenPix. | ||
|
||
:::caution Atenção | ||
Este documento espera que você já tenha um ambiente Magento2 ativo, e uma conta criada na OpenPix | ||
::: | ||
|
||
:::tip Dica | ||
Para utilizar este tutorial é necessário ter uma versão acima da 2.3.0 | ||
::: | ||
|
||
## Configurando o Plugin Magento2 | ||
|
||
### 1. Instale o Plugin OpenPix na sua instância Magento2 | ||
|
||
<Magento2Download /> | ||
|
||
### 2. Acesse a configuração do Magento2 | ||
|
||
Entre na plataforma da OpenPix e [clique aqui](https://app.woovi.com/home/applications/magento2/add/oneclick) ou vá em `API/Plugins` > `Magento2` > `Adicionar` | ||
|
||
![Tutorial-box](./__assets__/magento2-tutorial-box.png) | ||
|
||
### 2.1 Coloque o Link do seu site | ||
|
||
Coloque a URL do seu site no campo | ||
|
||
![Oneclick-Input](./__assets__/magento2-oneclick-input.png) | ||
|
||
### 2.2 Clique em salvar | ||
|
||
Clique no botão de salvar, e assim que tiver sucesso na sua integração você verá a seguinte mensagem: | ||
![Oneclick-Success](./__assets__/magento2-oneclick-success.png) | ||
|
||
## Configurações Avançadas | ||
|
||
### 1. 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. | ||
|
||
__Obs: Caso você siga sem a configuração deste campo suas cobranças serão salvas sem o cliente da mesma.__ | ||
|
||
Entre em Magento2 Admin -> Stores > Configuration -> Customers -> Customer Configuration | ||
|
||
![customer-sidemenu](./__assets__/magento2-customer-sidemenu.png) | ||
|
||
Primeiro ative o campo `Show VAT Number on Storefront` em `Create New Account Options`: | ||
|
||
![magento2-customer-create-new-account-options](./__assets__/magento2-customer-create-new-account-options.png) | ||
|
||
Em seguida em `Name and Address Options` ative o campo `Show Tax/VAT Number`: | ||
|
||
![magento2-customer-name-address-options.png](./__assets__/magento2-customer-name-address-options.png) | ||
|
||
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. | ||
|
||
### 2. Crie o Webhook dentro da Plataforma OpenPix | ||
|
||
Ao configurar a Store volte para a Plataforma OpenPix e registre o Webhook que será responsável para atualizar sua Store Magento2 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 store Magento2. 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 Store Magento2. O padrão é: <https://youstore.com.br/openpix/index/webhook> | ||
|
||
![Webhook](./__assets__/magento2-webhook-configuration.png) | ||
|
||
### 3. Realizar Pedido com Pix | ||
|
||
Escolha a opção de pagar o pedido usando Pix | ||
|
||
![Pay Pix](./__assets__/magento2-checkout-cart.png) | ||
|
||
Pague o Pix usando o app do seu banco. | ||
|
||
![Order](./__assets__/magento2-order.png) | ||
|
||
Valide que o status do Pedido mudou após o pagamento | ||
|
||
### 4. Visualizar Pedido com Pix | ||
|
||
Seu cliente poderá visualizar o pedido realizado via Pix dentro do detalhes do pedido. Basta clicar no botão que irá aparecer dentro da pagina de detalhe do pedido "Clique aqui para ver seu QRCode" | ||
|
||
![Order information](./__assets__/magento2-order-info.png) | ||
![Order](./__assets__/magento2-order-detail.png) | ||
|
||
### 5. Expiração do pedido Magento2 | ||
|
||
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. | ||
|
||
Indicamos que a expiração/cancelamento da order no magento possua um tempo semelhante ao tempo configurado na OpenPix. Exemplo: | ||
|
||
- tempo de expiração da cobrança OpenPix: 15 minutos | ||
- coloque os mesmos 15 minutos dentro da sua loja Magento. | ||
|
||
:::info | ||
No magento você pode utilizar o lifetime order seguindo a doc abaixo: | ||
|
||
- <https://docs.magento.com/user-guide/v2.3/sales/order-pending-payment-lifetime.html> | ||
::: | ||
|
||
### 6. Atualizando o plugin do Magento2 | ||
|
||
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. | ||
|
||
### 7. Debug logs Magento2 | ||
|
||
Para debugar o plugin OpenPix temos o arquivo de log e você encontra dentro de `var/log`: | ||
|
||
- `openpix.log`: arquivo que concentra logs referentes ao processo de criação de um novo pedido Magento e consequentemente a charge no lado da OpenPix e o processo de atualização da Order quando paga. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
63 changes: 63 additions & 0 deletions
63
docs/ecommerce/woocommerce/__components__/woocommerce-advanced-settings.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
## 1. Customer Salvar CPF/CNPJ | ||
|
||
Para salvar o customer da order na sua cobrança OpenPix é necessário que seja ativado um plugin que possibilite que o cliente informe o CPF/CNPJ no momento da compra. | ||
|
||
Indicamos o uso do plugin [woocommerce-extra-checkout-fields-for-brazil](https://wordpress.org/plugins/woocommerce-extra-checkout-fields-for-brazil/) para este caso. Uma vez ativado o plugin passará a salvar os clientes que informarem o CPF/CNPJ no momento da compra. | ||
|
||
__Obs: O uso não é obrigatório. Caso você siga sem a configuração do mesmo, suas cobranças serão salvas sem o cliente da mesma.__ | ||
|
||
## 2. Realizar Pedido com Pix no WooCommerce | ||
|
||
Escolha a opção de pagar o pedido usando Pix | ||
|
||
![Pay Pix](/img/ecommerce/woocommerce-pay-pix.png) | ||
|
||
Pague o Pix usando o app do seu banco. | ||
|
||
![Order](/img/ecommerce/woocommerce-order.png) | ||
|
||
Valide que o status do Pedido mudou após o pagamento | ||
|
||
## 3. Como configurar a expiração do pedido Woocommerce | ||
|
||
A cobrança da Openpix tem um valor de expiração padrão que equivale a 1 dia, já a configuração de expiração padrão do Woocommerce é de 60 minutos | ||
|
||
Para saber mais sobre Como configurar o tempo de expiração da OpenPix Charge [Clique aqui](/docs/flows/flow-edit-default-expiration). | ||
|
||
![Woocommerce Pedido](/img/ecommerce/woo-pedido.png) | ||
|
||
Para alterar e igualar esse tempo de expiração para a OpenPix e para Woocommerce você deve procurar no menu admin: | ||
|
||
`Woocommerce` > `Settings` > `Products` > `Inventory` | ||
|
||
Por último, alterar o valor do Hold stock para 1440 minutos equivalente a 1 dia | ||
|
||
![Woocommerce Expiracao](/img/ecommerce/woo-expiracao.png) | ||
|
||
## 4. Como selecionar qual deverá ser o status quando um novo pedido for gerado | ||
|
||
Por padrão quando a cobrança da Openpix é criada, o status do pedido é alterado para `Pending payment`, porém é possível configurar para qualquer status que você queira. | ||
|
||
![Woocommerce Status do Pedido Criado](/img/ecommerce/woocommerce-status-when-create-default.png) | ||
|
||
Basta clicar e selecionar qual status você quer que seja colocado no pedido quando a cobrança da Openpix for criada. | ||
|
||
Após esta alteração os novos pedidos quando forem criados irão receber o valor desse campo em seu status. | ||
|
||
## 5. Como selecionar qual deverá ser o status quando um pedido for pago | ||
|
||
Por padrão quando a cobrança da Openpix é paga, o status do pedido é alterado para `Processing`, porém é possível configurar para qualquer status que você queira. | ||
|
||
![Woocommerce Status do Pedido Pago](/img/ecommerce/woocommerce-status-when-paid-default.png) | ||
|
||
Basta clicar e selecionar qual status você quer que seja colocado no pedido quando a transação Pix for paga. | ||
|
||
Após esta alteração os novos pedidos quando forem pagos irão receber o valor desse campo em seu status. | ||
|
||
## 6. Como ver meus logs OpenPix em minha loja WooCommerce/Wordpress | ||
|
||
Você pode visualizar os logs OpenPix em sua loja através dos seguintes passos: | ||
|
||
- 1. Tenha acesso aos arquivos da loja | ||
- 2. Acesse o seguinte path: `/wp-content/uploads/wc_logs` | ||
- 3. Dentro de `wc_logs` você irá encontrar os arquivos de logs da openpix com o seguinte padrão de nome `woocommerce_openpix-2023-01-13-7d609d821235742dd8162bbb0ef84862` |
36 changes: 36 additions & 0 deletions
36
docs/ecommerce/woocommerce/__components__/woocommerce-oneclick.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
import Embed from 'react-embed'; | ||
|
||
## Veja o vídeo ou siga os passos abaixo | ||
|
||
<Embed url='https://youtu.be/iE_O4sJ9gVM' /> | ||
|
||
### 1. Instale a OpenPix na sua instância WooCommerce | ||
|
||
[OpenPix For WooCommerce](https://wordpress.org/plugins/openpix-for-woocommerce/) | ||
|
||
![Banner](/img/ecommerce/woocommerce-banner.png) | ||
![Install](/img/ecommerce/woocommerce-plugin-install.png) | ||
|
||
### 2. Configurando o Plugin WooCommerce | ||
|
||
Entre em plugins e clique em `Settings` para configurar o plugin | ||
|
||
![Configuracoes](/img/ecommerce/woocommerce/woocommerce-plugin-settings.png) | ||
|
||
### 3. Pegue a sua URL de Webhook | ||
|
||
Copie a URL de Webhook da sua loja WooCommerce | ||
|
||
![Webhook URL](/img/ecommerce/woocommerce/woocommerce-plugin-webhook.png) | ||
|
||
### 4. Configure a integração na OpenPix | ||
|
||
Entre na plataforma da OpenPix e [clique aqui](https://app.woovi.com/home/applications/woocommerce/add/oneclick) ou vá em `API/Plugins` > `WooCommerce` > `Adicionar` | ||
|
||
![Webhook URL](/img/ecommerce/woocommerce/woocommerce-plugin-tutorial-card.png) | ||
|
||
### 5. Coloque o Webhook URL | ||
|
||
Cole a URL de Webhook que você copiou no campo | ||
|
||
![Webhook URL](/img/ecommerce/woocommerce/woocommerce-plugin-tutorial.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
id: woocommerce-oneclick | ||
title: Integrando a OpenPix com WooCommerce | ||
sidebar_label: WooCommerce OpenPix 1-Click | ||
sidebar_position: 0 | ||
tags: | ||
- ecommerce | ||
- woocommerce | ||
- plugin | ||
--- | ||
import WooOneClick from './__components__/woocommerce-oneclick.mdx' | ||
import WooAdvancedSettings from './__components__/woocommerce-advanced-settings.mdx' | ||
|
||
:::caution Atenção | ||
Este documento espera que você já tenha um ambiente WooCommerce ativo, e uma conta criada na OpenPix | ||
Caso não tenha acesso à plataforma registre-se [aqui](https://app.openpix.com/register?src=wordpress-docs) | ||
::: | ||
|
||
## Instale o Plugin OpenPix na sua instância WooCommerce utilizando o 1-Click | ||
|
||
Este documento detalha passos necessários para conectar a sua plataforma de e-Commerce, baseada no WooCommerce, na OpenPix. | ||
|
||
<WooOneClick/> | ||
|
||
## Configurações avançadas WooCommerce | ||
|
||
<WooAdvancedSettings/> |
Oops, something went wrong.