Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cria documentação de Instalação #37

Merged
merged 5 commits into from
Aug 24, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 47 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,63 @@
[![GitHub commits desde a última Versão][badge-versionGitHub-commits]][link-GitHub-release]

# Descrição
A integração do módulo da Vindi permite criação e gestão de planos e assinaturas através do Magento2 de forma transparente.
A integração do módulo da Vindi permite criação e gestão de planos e assinaturas através do Magento 2 de forma transparente.

# Requisitos
- PHP **7.x.x** ou superior.
- MySQL **5.6.x** ou superior.
- cURL habilitado para o PHP.
- Certificado SSL.
- Conta ativa na [Vindi](https://www.vindi.com.br "Vindi").
- PHP **7.x.x** ou superior
- MySQL **5.6.x** ou superior
- cURL habilitado para o PHP
- Certificado SSL
- Conta ativa na [Vindi](https://www.vindi.com.br "Vindi")

# Instalação

# Atualização
É possível realizar a instalação do módulo da Vindi para Magento 2 via [.zip](https://github.com/vindi/vindi-magento2/archive/master.zip), via [Git](https://github.com) ou via [Composer](https://getcomposer.org).

#### Via [composer](https://getcomposer.org)
- Vá até o diretório raíz do Magento e adicione o módulo
> `composer require vindi/vindi-magento2`
- Atualize os módulos disponíveis do Magento
> `bin/magento setup:upgrade`
- O módulo **Vindi_Payment** deverá ser exibido na lista de módulos do Magento
> `bin/magento module:status`

#### Via [git](https://github.com)
- Vá até o diretório raíz do Magento e adicione o módulo
> `git clone git@github.com:vindi/vindi-magento2.git app/code/Vindi/Payment/`
- Atualize os módulos disponíveis do Magento
> `bin/magento setup:upgrade`
- O módulo **Vindi_Payment** deverá ser exibido na lista de módulos do Magento
> `bin/magento module:status`

#### Via [.zip](https://github.com/vindi/vindi-magento2/archive/master.zip)
- Crie a(s) seguinte(s) pasta(s) dentro da pasta **app** do Magento
> `code/Vindi/Payment`
- Faça o download do [.zip](https://github.com/vindi/vindi-magento2/archive/master.zip)
- O caminho deve ser **app/code/Vindi/Payment**
- Extraia os arquivos do **.zip** na pasta **Payment**
- No diretório raíz, atualize os módulos disponíveis do Magento
> `bin/magento setup:upgrade`
- O módulo **Vindi_Payment** deverá ser exibido na lista de módulos do Magento
> `bin/magento module:status`

# Configuração
1. Configurando sua conta Vindi
- No painel de Administração do Magento, acesse *Vindi -> Configuração*
- Selecione o modo de operação e informe a chave da API de sua conta Vindi
- Você deve copiar o link de configuração dos Webhooks, para inseri-lo na plataforma da Vindi
- Acesse [Vindi](https://app.vindi.com.br) -> Configurações -> Webhooks -> Novo webhook -> e cole o link no campo de URL
- Você pode clicar na opção **Testar** para validar a configuração
- Para finalizar a configuração, basta clicar na opção "Criar Webhook"
1. Habilitando/Configurando os métodos de pagamento
- Em *Lojas -> Vendas -> Métodos de pagamento*, configure e habilite o método de pagamento **Vindi - Cartão de Crédito**

## Dúvidas
Caso necessite de informações sobre a plataforma ou API por favor siga através do canal [Atendimento Vindi](http://atendimento.vindi.com.br/hc/pt-br)
Caso necessite de informações sobre a plataforma ou a API, por favor, siga através do canal [Atendimento Vindi](http://atendimento.vindi.com.br/hc/pt-br)

## Contribuindo
Por favor, leia o arquivo [CONTRIBUTING.md](CONTRIBUTING.md).

Caso tenha alguma sugestão ou bug para reportar por favor nos comunique através das [issues](./issues).
Caso tenha alguma sugestão ou bug para reportar, por favor, nos comunique através das [issues](./issues).

## Changelog
Tipos de mudanças
Expand Down