Skip to content

Commit

Permalink
Add readme (#7)
Browse files Browse the repository at this point in the history
* doc(wip): add first comments.

* doc: add missing docs.

* doc: fix text.

* doc: refactor text.
  • Loading branch information
mrayone authored Feb 16, 2022
1 parent 0c56d26 commit 5f00519
Showing 1 changed file with 51 additions and 7 deletions.
58 changes: 51 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,59 @@
# Hotmart Criador de Membros WebHook (Hotmart Member Creator WebHook) Beta 1.0
Um Plugin para WordPress que realiza a integração com o WebHook do Hotmart. O plugin tem como função criar um usuário em seu blog quando o cliente efetivar uma compra de algum curso.
Estão presentes neste plugin as seguintes funcionalidades:
# Hotmart Criador de Membros WebHook (Hotmart Member Creator WebHook)

1. Integração com API do SendGrid E-mail. Esta integração é opcional já que o plugin utiliza a função "wp_mail" do WordPress para utilizar o servidor de SMTP da própria hospedagem.
O hotmart member creator gera um Webhook de integração do hotmart com o seu blog. Ao ativar este plugin você contém as seguintes funcionalidades:

2. Verifica o campo status do WebHook para criar usuário quando a compra estiver "aprovada" e excluir o mesmo caso seja solicitado "estorno" ou "reembolso".
1. Criação de membros com a função padrão definida.
2. Integração para envio de e-mail com SendGrid.
3. Customização de mensagens de e-mail com **_Helpers_**.

## Observações
## Requisitos :warning:

O plugin utiliza a função de rest_api do WordPress. Desta forma recomenda-se a utilização das versões >= 4.5 e o links-permanentes no modelo "nome do post".
- PHP: >=5.6
- WordPress: >= 5.6
- Hotmart WebAPI: V1.
- Conhecimento mínimo de wordpress e instalação de plugins.

> O hotmart atualizou a sua versão de API, logo mais haverá a atualização no plugin também. Para novos usuários sugiro aguardar a modificação a menos que tenha disponível a V1 da API para você.
## Instalação

Para instalar no seu blog, basta baixar o pacote de release aqui do github em .zip e adicionar no seu blog, conforme as imagens 1, 2 e 3.

#### 1. Figura da área de releases.

![image](https://user-images.githubusercontent.com/17658240/154344685-4b386c38-3472-45c8-acbb-bfb19472213f.png)

#### 2. Figura da área de releases.

![image](https://user-images.githubusercontent.com/17658240/154344807-97f3499b-aa34-4a48-b8e3-357553a0d216.png)

- Obs: O Download desta seção está relacionada a versão do código conforme a descrição.
- Para baixar basta clicar em **Source code** conforme a extensão desejada.

### 3. Figura de envio do plugin

No seu blog você deve acessar a página `https://<url-do-seu-blog>/wp-admin/plugin-install.php` e enviar o plugin `hotmart-webhook-create-member-<versao>.zip`

![image](https://user-images.githubusercontent.com/17658240/154352665-7b060e5a-0406-4315-ab8d-5f1e86aab6b8.png)

![image](https://user-images.githubusercontent.com/17658240/154352704-8eb1a21a-dfa8-4b18-bddb-e2e983491df7.png)

### Instalação via página de plugins do wordpress

:construction:

### Configuração

A configuração exige a informação do token do [hotmart](https://app-vlc.hotmart.com/tools/webhook/auth), e para isso você precisa estar registrado devidamente na plataforma.

![localhost_8080_wp-admin_admin php_page=hmu_plugin_opts](https://user-images.githubusercontent.com/17658240/154352086-fdfcd699-21d3-4d27-9d44-adc5fd4452a8.png)

### Como configurar no hotmart?

O próprio hotmart já disponibiliza uma [documentação](https://developers.hotmart.com/docs/pt-BR/1.0.0/webhook/about-webhook/) bem interessante, replica-la aqui seria repetitivo.

### Configuração do .htaccess (Servidor Apache)

https://github.com/mrayone/hotmart-webhook-create-member/blob/master/examples/.htaccess

> Obrigado pela utilização desta solução.

0 comments on commit 5f00519

Please sign in to comment.