search

gerencianet / gn-api-whmcs

Módulo WHMCS integrado a API Gerencianet. Este Plug-in está preparado para integração à API Boletos da Gerencianet, que lhe permite a realização de cobranças por boleto/Bolix muito mais.
https://dev.gerencianet.com.br/docs/whmcs
7 stars 12 forks source link
billet boleto bolix whmcs whmcs-payment whmcs-payment-gateway

readme

Módulo Efí para WHMCS

Instalação

  1. Faça o download da última versão do módulo;
  2. Descompacte o arquivo baixado;
  3. Copie o arquivo efi.php e a pasta efi, para o diretório /modules/gateways da instalação do WHMCS;
  4. Altere as permissões do arquivo copiado utilizando o comando: chmod 777 modules/gateways/efi.php
  5. Altere as permissões da pasta copiada utilizando o comando: chmod 777 modules/gateways/efi/ -R
  6. Copie o arquivo efi.php e a pasta efi, disponível no diretório callback, para o diretório modules/gateways/callback.
  7. Altere as permissões do arquivo copiado utilizando o comando: chmod 777 modules/gateways/callback/efi.php
  8. Altere as permissões da pasta copiada utilizando o comando:: chmod 777 modules/gateways/callback/efi -R
  9. Copie o arquivo efi.php, disponível no diretório hooks, para o diretório includes/hooks. Ele deve estar no caminho includes/hooks/efi.php
  10. Altere as permissões do arquivo copiado utilizando o comando: chmod 777 includes/hooks/efi.php
  11. Crie uma pasta na raiz do seu servidor e insira seu certificado na pasta.

Ao final da instalação, os arquivos do módulo Efí devem estar na seguinte estrutura no WHMCS:

includes/hooks/
  |- efi.php
 modules/gateways/
  |- callback/efi/
  |- callback/efi.php
  |- efi/
  |- efi.php

Certificado para utilização da API PIX

Todas as requisições devem conter um certificado de segurança que será fornecido pela Efí dentro da sua conta, no formato PFX(.p12). Essa exigência está descrita na integra no manual de segurança do PIX.

Caso ainda não tenha seu certificado, basta seguir o passo a passo do link a seguir para gerar um novo: Clique Aqui

Configuração do Módulo

Tela de Configuração

  1. Client_Id Produção: Deve ser preenchido com o client_id de produção de sua conta Efí. Este campo é obrigatório e pode ser encontrado no menu "API" -> "Aplicações". Em seguida, selecione sua aplicação criada, conforme é mostrado no link;
  2. Client_Secret Produção: Deve ser preenchido com o client_secret de produção de sua conta Efí. Este campo é obrigatório e pode ser encontrado no menu "API" -> "Aplicações". Em seguida, selecione sua aplicação criada, conforme é mostrado no link;
  3. Client_Id Desenvolvimento: Deve ser preenchido com o client_id de desenvolvimento de sua conta Efí. Este campo é obrigatório e pode ser encontrado no menu "API" -> "Aplicações". Em seguida, selecione sua aplicação criada, conforme é mostrado no link;
  4. Client_Secret Desenvolvimento: Deve ser preenchido com o client_secret de desenvolvimento de sua conta Efí. Este campo é obrigatório e pode ser encontrado no menu "API" -> "Aplicações". Em seguida, selecione sua aplicação criada, conforme é mostrado no link;
  5. Identificador da conta: Deve ser preenchido com o identificador da sua conta Efí. Este campo é obrigatório e pode ser encontrado no menu "API" -> "Introdução"->"Identificador da Conta", conforme é mostrado no link;
  6. Usuário administrador do WHMCS: Deve ser preenchido com o usuário administrador do WHMCS. É necessário utilizar o mesmo usuário que o administrador do WHMCS utiliza para fazer login na área administrativa de sua conta. Este campo é de preenchimento obrigatório;
  7. Desconto do Boleto: Informe o valor desconto que deverá ser aplicado aos boletos gerados exclusivamente pela Efí. Esta informação é opcional;
  8. Tipo de desconto: Informe o tipo de desconto (porcentagem ou valor fixo) que deverá ser aplicado aos boletos gerados exclusivamente pela Efí. Esta informação é opcional;
  9. Número de dias para o vencimento do Boleto: Informe o número de dias corridos para o vencimento do boleto Efí após a cobrança ser gerada. Se o campo estiver vazio, o valor será 0;
  10. E-mail de cobrança - Efí: Caso seja de seu interesse, habilite o envio de emails de cobrança da Efí para o cliente final;
  11. Configuração de Multa: Caso seja de seu interesse, informe o valor, em porcentagem, cobrado de multa após o vencimento. Por exemplo: se você quiser 2%, você deve informar 2. Mínimo de 0.01 e máximo de 10. Integer;
  12. Configuração de Juros: valor cobrado de juros por dia após a data de vencimento. Por exemplo: se você quiser 0,033%, você deve informar 0.033. Mínimo de 0.001 e máximo de 0.33;
  13. Observação: Permite incluir no boleto uma mensagem para o cliente;
  14. Sandbox: Caso seja de seu interesse, habilite o ambiente de testes da API Efí;
  15. Debug: Neste campo é possível habilitar os logs de transação e de erros da Efí no painel WHMCS;
  16. Chave PIX: Se utilizado CNPJ, informar sem pontos e espaços, ex. 11111111111121;
  17. Certificado Pix: Deve ser preenchido com o caminho do certificado salvo em seu servidor no passo 10 da instalação;
  18. Desconto: Informe o valor de desconto que deverá ser aplicado ao pix gerado exclusivamente pela Efí;
  19. Validade da Cobrança PIX: Deve ser informado o período de validade em dias da cobrança PIX;
  20. Nome: Deve ser informado o nome do titular da conta;
  21. Documento: Deve ser informado o documento (CPF ou CNPJ) do titular da conta;
  22. Agência: Deve ser informado a agência do titular;
  23. Conta : Deve ser informado o número referente a conta;
  24. Tipo de conta: Deve ser informado o tipo de conta referente ao titular ;
  25. Validar mTLS: Entenda os riscos de não configurar o mTLS acessando o link https://gnetbr.com/rke4baDVyd;
  26. PIX: Selecione essa opção caso deseje deixar a opção PIX como forma de pagamento;
  27. Boleto: Selecione essa opção caso deseje deixar a opção boleto como forma de pagamento;
  28. Cartão de Crédito: Selecione essa opção caso deseje deixar a opção de cartão de crédito como forma de pagamento;
  29. Open Finance: Selecione essa opção caso deseje deixar a opção de open finance como forma de pagamento.