Modules Pay · Auto Login MPAY
v2.0WHMCS 9.0+PHP 8.2+PT-BR · PT-PT · EN · ES · FR

Guia de Instalação

Instale e configure o Auto Login MPAY em poucos minutos. Seus clientes passam a abrir faturas, tickets e cotações direto pelo e-mail, sem digitar a senha.

Começar instalação Guia de utilização

Requisitos

Confira se o seu ambiente atende aos itens abaixo antes de instalar.

WHMCS 9.0 ou superiorCompatível com as mudanças de autenticação do WHMCS 9
PHP 8.2 ou superiorPHP 8.3 recomendado
Extensão cURLUsada na validação da licença
Licença ativaChave fornecida pela Modules Pay
5 idiomasPortuguês (Brasil e Portugal), inglês, espanhol e francês

Não é preciso criar credenciais de API. O módulo usa a API interna do WHMCS (localAPI), então não depende de Identifier/Secret nem de liberar IP na API.

Conteúdo do pacote

Ao descompactar o arquivo do módulo, você encontrará esta estrutura:

modules/addons/autologinmpay/ → enviar para /modules/addons/ do WHMCS ├── autologinmpay.php configuração e painel do addon ├── hooks.php gera os links nos e-mails ├── funcoes.php funções internas ├── diagnostico.php página de diagnóstico ├── permissoes.php correção de permissões ├── ui.php visual do addon ├── i18n.php traduções ├── whmcs.json ├── lang/ portuguese-br, portuguese-pt, english, spanish, french ├── docs/ guias (pt-br, pt-pt, en, es, fr) └── imagens/ leia-antes-de-instalar/ ├── autologin.php → enviar para a RAIZ do WHMCS └── README.md

Os guias ficam dentro da pasta do addon (docs/) para que os botões Guia de instalação e Guia de utilização do painel abram a documentação no seu próprio servidor, no idioma do administrador.

Passo a passo

Siga as etapas na ordem. O processo leva cerca de 5 minutos.

  1. Envie a pasta do addon

    Por FTP ou pelo Gerenciador de Arquivos da hospedagem, envie a pasta autologinmpay (com as subpastas lang/, docs/ e imagens/) para:

    /caminho-do-whmcs/modules/addons/autologinmpay/

  2. Envie o autologin.php para a raiz

    Copie leia-antes-de-instalar/autologin.php para a raiz do WHMCS, a mesma pasta onde ficam o init.php e o configuration.php:

    /caminho-do-whmcs/autologin.php

    Sem esse arquivo na raiz, os links dos e-mails dão erro 404. É ele que faz o login do cliente.

  3. Ative o módulo

    No painel administrativo do WHMCS, acesse Configurações › Configurações do Sistema › Módulos Addon.

    Localize Auto Login MPAY e clique em Ativar. A tabela do módulo é criada e os links das faturas em aberto já são gerados.

  4. Informe a licença

    Clique em Configurar, preencha o campo Licença e clique em Salvar Alterações. Com a licença válida, as demais opções aparecem.

  5. Libere o Controle de Acesso

    Ainda em Configurar, na seção Controle de Acesso, marque o grupo do seu administrador (por exemplo, Full Administrator) e salve.

    Sem esse passo não é possível abrir a página do addon nem os botões Abrir diagnóstico e Corrigir permissões.

  6. Ajuste as opções

    Escolha o Administrador do WHMCS, a expiração do link e, para faturas, tickets e cotações, se o módulo substitui a tag nativa ({$invoice_link}, {$ticket_link}, {$quote_link}) ou se você vai usar {$login_link}. Cada opção está explicada no Guia de utilização.

Pronto! A partir de agora, os e-mails de fatura, ticket e cotação já saem com o link de acesso automático.

Idiomas

O módulo fala português (Brasil), português (Portugal), inglês, espanhol e francês. Não há nada para configurar.

  • Telas do addon (configuração, painel, diagnóstico e permissões): idioma do perfil do administrador logado, definido em Minha Conta › Idioma.
  • Página vista pelo cliente quando o link não pode ser usado: idioma do cliente dono do link (ou o escolhido por ele na área do cliente).
  • Guias: os botões do painel abrem a versão no idioma do administrador. Cada guia tem um seletor de idioma no topo.
  • Idiomas não suportados usam o inglês.

Cache e CDN

Se o seu servidor usa cache de página, o link de acesso não pode ficar em cache.

Cada clique precisa gerar um token de login novo, que vale por pouco tempo e só pode ser usado uma vez. O módulo já envia cabeçalhos anti-cache, mas confira:

  • LiteSpeed Cache: adicione /autologin.php à lista de URIs que não vão para o cache.
  • Cloudflare: crie uma regra de cache com Bypass para */autologin.php*.
  • Nginx, Varnish ou proxy: não faça cache de /autologin.php.
  • Depois de instalar ou atualizar, limpe o cache do servidor e da CDN.

Verificar a instalação

Use o diagnóstico do módulo para confirmar que está tudo funcionando.

  1. Abra o diagnóstico

    Módulos Addon › Auto Login MPAY › Configurar › Abrir diagnóstico

    Confira se o autologin.php e os arquivos de idioma aparecem como OK.

  2. Teste o token de login

    Em Testar token de login (SSO), informe o ID de um cliente de teste. Copie o link B, cole numa janela anônima e tecle Enter. O cliente deve entrar logado na área do cliente.

  3. Teste um e-mail real

    Abra uma fatura em aberto e clique em Enviar e-mail. No e-mail recebido, clique no link: a fatura deve abrir com o cliente já logado.

Para testar, sempre clique no link ou use uma janela anônima. Ao colar a URL na barra, alguns navegadores pré-carregam a página e gastam o token de uso único, o que gera o erro The access token provided is invalid.

Permissões dos arquivos

Arquivos enviados por FTP ou extraídos de um ZIP podem chegar com permissões erradas, o que em muitos servidores causa erro 500.

Na configuração do addon, clique em Ferramentas › Corrigir permissões. A página mostra as permissões atuais da pasta do addon e do autologin.php da raiz, e corrige com um clique:

  • Pastas: 755
  • Arquivos: 644
  • Nenhum outro arquivo do WHMCS é alterado.

O PHP só consegue alterar arquivos que pertencem ao usuário dele. Se algum item falhar, a página mostra os comandos para corrigir pelo SSH, ou ajuste pelo Gerenciador de Arquivos/FTP.

Atualizar uma versão anterior

Vindo da versão para WHMCS 8 ou de uma versão anterior do módulo?

  1. Substitua os arquivos do addon

    Envie a pasta modules/addons/autologinmpay/ completa, sobrescrevendo a anterior (inclusive lang/ e docs/).

  2. Substitua o autologin.php da raiz

    Esse arquivo mudou para o WHMCS 9 e precisa ser atualizado junto com a pasta do addon.

  3. Abra a configuração do addon

    A tabela é atualizada automaticamente. As opções salvas (expiração e tags) são convertidas para o novo formato, independente do idioma, e as credenciais de API antigas (Identifier/Secret), que não são mais usadas, são apagadas do banco.

  4. Limpe o cache

    Limpe o cache do servidor e da CDN, se houver.

Os links enviados em e-mails antigos continuam funcionando após a atualização.

Se você criou uma credencial de API só para este módulo, pode excluí-la em Configurações › Administradores › Credenciais da API. O antigo manual em PDF foi substituído por estes guias.

Desinstalação

Desative o módulo em Configurações do Sistema › Módulos Addon e depois apague a pasta modules/addons/autologinmpay/ e o arquivo autologin.php da raiz.

Atenção: ao desativar, a tabela de links é apagada. Os links já enviados por e-mail deixam de funcionar, e o cliente precisa fazer login normalmente.

Solução de problemas

SintomaCausa provávelSolução
Link do e-mail dá erro 404autologin.php não está na raizEnvie o arquivo para a raiz do WHMCS (passo 2).
Cliente vê "Acesso automático indisponível" (código AL-LIC)Licença inválida, expirada ou de outro domínioConfira a chave na configuração ou fale com o suporte.
Opções do módulo não aparecemLicença ainda não validadaSalve a licença e recarregue a página.
The access token provided has expiredautologin.php desatualizado ou link em cacheAtualize o autologin.php, tire-o do cache e limpe o cache.
The access token provided is invalidToken já usado (pré-carregamento do navegador ou página recarregada)Clique de novo no link do e-mail: cada clique gera um token novo.
Cliente vê "Não foi possível entrar automaticamente" (código AL-SSO) e o diagnóstico mostra invalid_client. client credentials are requiredCredencial OAuth interna do WHMCS ilegível, geralmente porque o banco de dados foi copiado de outra instalaçãoNo diagnóstico, rode Testar token de login e clique em Reparar credencial e testar (faça backup do banco antes).
Erro 500 ou página em branco no link ou no addonPermissões incorretas (pastas/arquivos graváveis por todos)Use o botão Corrigir permissões.
"Acesso negado" no diagnósticoGrupo do administrador sem acesso ao addonMarque o grupo em Controle de Acesso (passo 5).
Telas do addon em inglêsIdioma do seu perfil não é um dos 5 suportados, ou faltam arquivos em lang/Altere em Minha Conta › Idioma e confira os arquivos de idioma no diagnóstico.
Botões dos guias abrem página não encontradaPasta docs/ não foi enviadaEnvie a pasta do addon completa (passo 1).

Todas as mensagens e os logs estão explicados no Guia de utilização.