ajuda de WHMCS Apps

API 1

• Usar a API diretamente Todos os endpoints estão em /modules/addons/whmcspwa/api/index.php. Envie um cabeçalho Authorization: Bearer com o token de acesso. O ecrã de referência lista a tabela de rotas ativa, gerada a partir do próprio router.

Personalização 4

• Ícones das aplicações Forneça um PNG de 192px e outro de 512px. Quadrados, sem cantos arredondados e sem transparência: cada plataforma aplica a sua própria máscara, e um ícone transparente fica com fundo preto no iOS.
• Cor de marca e destaque A cor de marca pinta os botões principais da aplicação, as ligações e a barra de estado do telemóvel. O destaque fica reservado para coisas que precisam de atenção, como uma fatura em atraso. Mantê-las distintas é o que torna um saldo por pagar legível num relance.
• Pastel, claro, escuro e automático Automático é a predefinição e segue o que estiver definido no telemóvel: a sua paleta clara durante o dia, o tema escuro à noite. Pastel é um fundo esbranquiçado com linhas suaves, claro é o mesmo esquema em cinzentos mais frios, e…
• O ícone incluído com o módulo Até carregar o seu, a aplicação usa uma pilha de unidades de rack com uma luz de estado acesa. É deliberadamente genérico, e é um ícone a sério e não um quadrado colorido, para que uma instalação sem nada configurado continue…

Funcionalidades 8

• Anexar uma foto ou ficheiro, e quem a vê A equipa pode anexar ficheiros a um ticket a partir de um telemóvel, incluindo diretamente da câmara, e escolher se o cliente os vê. A predefinição é só para a equipa, e essa predefinição é intencional: o erro contra o qual vale a pena proteger é um…
• Anexar uma captura de ecrã a um novo ticket Ao abrir um ticket na aplicação do cliente, há uma área de anexo opcional por baixo da mensagem: Escolher um ficheiro seleciona qualquer coisa do dispositivo, e Tirar uma foto abre a câmara, que é a forma rápida de anexar uma…
• Fechar o seu próprio ticket Um serviço num servidor cPanel mostra uma secção cPanel em Utilização quando a conta está ativa, com as ferramentas do dia a dia. Escolher uma abre o cPanel num novo separador, com sessão iniciada e nessa ferramenta, sem palavra-passe para…
• Ficheiros num ticket Os anexos aparecem por baixo da mensagem com que vieram e descarregam-se com um toque. Servir ficheiros a partir do disco é a coisa mais perigosa que este módulo faz, por isso as regras são rigorosas: a ligação indica o ficheiro em vez de quem chama fazer…
• Abrir o cPanel Um serviço num servidor cPanel mostra uma secção cPanel em Utilização quando a conta está ativa, com as ferramentas do dia a dia: Gestor de ficheiros, Contas de email, Bases de dados, phpMyAdmin, Cópias de segurança e mais. Escolher uma abre o cPanel num novo separador, com sessão iniciada…
• Imprimir uma fatura A aplicação gera a sua própria cópia imprimível em vez de ir buscar o PDF do WHMCS, porque esse PDF é servido por trás de uma sessão da área de cliente que a aplicação não tem, e pedir a alguém que inicie sessão duas vezes para ver a sua própria fatura…
• Ativar e desativar secções Uma secção desativada desaparece da navegação da aplicação e os seus endpoints da API começam a recusar pedidos. As duas coisas acontecem em conjunto, por isso ocultar um ecrã retém realmente os dados em vez de apenas ocultar o botão.
• O que os clientes veem primeiro Um serviço num servidor cPanel mostra um botão Abrir cPanel em Utilização quando a conta está ativa. Inicia a sua sessão diretamente no cPanel num novo separador, sem palavra-passe para escrever, e abre na página inicial do cPanel, onde o Gestor de…

Guias 7

• Guia: Pôr os clientes na aplicação O anúncio, a instalação e o que fazer quanto aos iPhones.Cerca de 30 minutos.Definir o endereço da aplicação Aponte um subdomínio como app.yourhosting.com para a aplicação e use-o em todo o lado. Um endereço curto é a diferença entre as pessoas o escreverem e as pessoas…
• Guia: Gerir um ticket do telemóvel até à resolução O que um cliente envia, o que a equipa vê e como se comportam as respostas offline.Cerca de 10 minutos.Ativar os tickets Os clientes recebem uma lista dos seus tickets e podem abrir novos em qualquer departamento que tenha configurado no WHMCS.Um cliente abre um ticket…
• Guia: Da fatura ao pagamento num telemóvel Como uma notificação se torna uma fatura liquidada.Cerca de 10 minutos.A fatura é emitida O WHMCS cria a fatura como habitualmente. A aplicação intercepta esse evento e notifica o cliente, com o valor e a data de vencimento no corpo da notificação.O cliente toca na notificação…
• Guia: Lançar a aplicação pela primeira vez De uma instalação nova até um cliente tocar na sua aplicação no ecrã inicial.Cerca de 15 minutos.Executar a configuração O assistente verifica o HTTPS, as extensões PHP e a sua versão do WHMCS antes de mais nada, para que descubra agora um impedimento em vez de…
• Guia: Pôr o código de instalação onde é lido Do código gerado até aos clientes com a aplicação no ecrã inicial.Cerca de 30 minutos.Fixe o endereço da aplicação antes de imprimir seja o que for O código codifica o endereço que estiver definido aqui. Imprima-o, depois mude o endereço, e todos os códigos impressos apontam…
• Guia: Ativar as passkeys sem uma vaga de pedidos de suporte Ative-as, comprove que funcionam no seu próprio dispositivo e depois deixe as pessoas descobri-las.Cerca de 20 minutos, e depois uma semana de observação.Decida primeiro o domínio Antes de alguém se registar, defina o domínio a que as passkeys ficam associadas. Se a aplicação puder mudar para app.yourhosting.com…
• Guia: Quando algo não está a funcionar As verificações que resolvem a maioria dos reportes, pela ordem em que vale a pena tentá-las.Cerca de 5 minutos.Verifique primeiro o painel de saúde Indica o HTTPS, as extensões PHP, a conta de administrador da API e as chaves de notificação. A maioria dos problemas é uma destas quatro não estar definida.Ninguém consegue…

Instalação 2

• Pôr o código à frente das pessoas O painel da área de cliente faz o trabalho automaticamente: quem tem sessão iniciada num computador vê o código, quem está num telemóvel vê antes um botão de instalação, porque um telemóvel não se pode ler a si próprio. Para além disso, os dois locais que realmente convertem…
• O código de instalação Um código QR com o endereço da sua aplicação, gerado pelo módulo e não por um serviço de terceiros, para que nenhuma empresa externa conheça o tráfego dos seus clientes. Reflete sempre o endereço da aplicação do ecrã Personalização. Imprima-o nas faturas, mostre-o…

Notificações 4

• Chaves de notificação As chaves VAPID identificam o seu servidor perante os serviços de push da Apple, da Google e da Mozilla. Gere-as uma vez. Voltar a gerá-las invalida todas as subscrições existentes, por isso toda a gente tem de voltar a ativar as notificações.
• Notificações no iPhone O iOS só entrega notificações web depois de a aplicação ter sido adicionada ao ecrã inicial, e o pedido de permissão tem de vir de um toque. A aplicação pede-a no ecrã Notificações e não no primeiro carregamento exatamente por esta…
• Notificar a equipa sobre tickets Com as notificações ativadas, a equipa também pode ser avisada sobre tickets: quando é aberto um novo e quando um cliente responde a um existente. Uma resposta num ticket atribuído a um membro específico da equipa vai para…
• O que desencadeia uma notificação Fatura criada, pagamento recebido, pagamento falhado e uma resposta da equipa num ticket. Cada um é um hook separado do WHMCS, por isso pode desativar um sem mexer nos outros.

Offline 1

• O que funciona sem rede Os últimos ecrãs que alguém carregou continuam legíveis, e uma resposta a um ticket escrita offline fica em fila e é enviada assim que a ligação regressa. Os pagamentos precisam sempre de uma ligação ativa.

Passkeys 6

• Bloquear a aplicação Um dispositivo pode ser configurado para bloquear a aplicação quando esta passa para segundo plano, para que reabri-la exija uma impressão digital. A forma óbvia de construir isso é um pedido à frente da sessão existente, mas seria teatro:…
• Exigir impressão digital, rosto ou PIN Com isto ativado, o dispositivo tem de confirmar quem o está a segurar antes de assinar, por isso um telemóvel que alguém apanhou desbloqueado não basta por si só. Com isto desativado, basta a presença: um toque na chave de segurança…
• Contas da equipa com autenticação de dois fatores O WHMCS não publica nenhuma forma suportada de verificar um segundo fator da equipa fora do seu próprio formulário de login. Verificar apenas a palavra-passe faria desta aplicação a forma fácil de contornar um controlo que ativou deliberadamente, por isso as contas com dois fatores não podem…
• O domínio a que as passkeys ficam associadas Uma passkey está ligada a um domínio e aos seus subdomínios, e essa associação é o que torna impossível o phishing. Em branco significa que o módulo o deduz a partir do endereço da sua aplicação. Defina-o deliberadamente se puder vir a mudar a aplicação mais tarde:…
• O que é uma passkey Um par de chaves que o telemóvel ou o portátil cria e guarda por trás do seu próprio ecrã de bloqueio. Iniciar sessão significa que o dispositivo assina um desafio único com a metade privada, que nunca sai dele nem atravessa a rede. Não há…
• Quando alguém perde o dispositivo A palavra-passe continua a funcionar, por isso ninguém fica bloqueado. As passkeys guardadas no Porta-chaves iCloud ou no Gestor de Palavras-passe da Google também acompanham a pessoa para um dispositivo de substituição por si só. Se um dispositivo se perdeu mesmo, inicie sessão com a palavra-passe,…

Segurança 4

• Limite de pedidos Pedidos por minuto a partir de um endereço IP. As tentativas de início de sessão são limitadas separadamente e de forma mais apertada. Aumente-o se um escritório grande por trás de um só endereço for bloqueado.
• Rodar a chave de assinatura Rodar termina a sessão de toda a gente na aplicação, em todo o lado, de imediato. Use-o se suspeitar que um token foi divulgado. Ninguém perde dados; apenas voltam a iniciar sessão.
• Sessões e tokens Iniciar sessão devolve um token de acesso de curta duração e um token de atualização de longa duração. Os tokens de atualização rodam a cada utilização; se um antigo for apresentado outra vez, toda a sessão é revogada, e é assim que um token roubado é apanhado.
• Porque é que o início de sessão da equipa precisa sequer de uma verificação O WHMCS publica uma chamada suportada para validar a palavra-passe de um cliente, e nenhuma para validar a de um membro da equipa, por isso a aplicação tem de ler ela própria o hash guardado. O sítio onde esse hash está mudou entre versões do WHMCS: as instalações mais antigas guardam-no em…

Configuração 5

• Conta de administrador da API A aplicação verifica palavras-passe e abre tickets chamando o WHMCS como este administrador. Escolha uma conta dedicada apenas com as permissões de que a aplicação precisa, em vez do login diário de uma pessoa, para poder revogá-la sem bloquear ninguém.
• Pôr a aplicação no ecrã inicial O Android e o Chrome de computador mostram automaticamente um pedido de instalação assim que a aplicação tem um manifesto, um ícone de pelo menos 192px e um service worker. O iOS não tem pedido: as pessoas usam Partilhar e depois Adicionar ao ecrã principal. A aplicação deteta…
• Mostrar o detalhe dos erros Normalmente, quando um pedido falha, a aplicação mostra uma mensagem curta e genérica e o detalhe real vai para o registo de atividade. Com isto ativado, essa mensagem real e o sítio onde aconteceu também voltam para a aplicação. Destina-se…
• Verificar o certificado do cPanel Para abrir o cPanel, a aplicação inicia a sessão do cliente através da própria API do servidor cPanel por uma ligação segura. O certificado dessa ligação é verificado por predefinição. Alguns servidores apresentam um certificado autoassinado ou com o nome de anfitrião errado na porta da API, o que faz…
• Porque é necessário HTTPS Os navegadores recusam instalar uma aplicação no ecrã inicial, registar um service worker ou entregar notificações através de HTTP simples. O localhost é a única exceção, e é por isso que os testes funcionam antes de o seu certificado funcionar.

Equipa 19

• Agir sobre um serviço ou um domínio No ecrã de um cliente, cada serviço tem as ações adequadas ao seu estado: suspender um ativo, reativar um suspenso, executar a criação/configuração de um ainda pendente. Uma suspensão pede um motivo, porque esse motivo é a única…
• Adicionar uma nota interna O ecrã de um ticket tem uma caixa Nota interna para a equipa, por baixo da caixa de resposta. O que escrever aí é guardado como nota de ticket do WHMCS — só para a equipa, e o cliente nunca é notificado. Serve para o comentário contínuo…
• Cancelar uma fatura Uma fatura por pagar, em rascunho ou em atraso pode ser cancelada a partir do seu próprio ecrã, o que impede o WHMCS de a cobrar. É oferecido no telemóvel porque é reversível: uma fatura cancelada pode ser reposta como por pagar a partir do…
• Ações rápidas do cliente O ecrã de um cliente tem um conjunto de ações para as coisas que a equipa faz sem abrir um computador. Adicionar crédito coloca um saldo na conta. Enviar reposição de palavra-passe desencadeia o email de reposição do WHMCS, para que o cliente receba a ligação habitual…
• Contactar e agir sobre um cliente O ecrã de um cliente tem botões de chamada, SMS e email no topo, e um botão WHMCS que abre a ficha completa na área de administração. Os três primeiros são ligações do dispositivo: passam para o marcador do telemóvel, a aplicação de mensagens…
• Controlar o que os clientes podem fazer Controla o que os clientes podem ver e fazer na aplicação a dois níveis. Conta, Permissões da aplicação do cliente define as predefinições que todos os clientes herdam: para cada coisa, como pagar faturas, abrir tickets ou abrir o cPanel, um interruptor decide se…
• Convidar clientes para a aplicação Pode enviar aos clientes por email uma ligação para a aplicação com instruções para a adicionarem ao ecrã inicial; iniciam sessão com a conta que já têm. Envie a um a partir do ecrã do cliente com o botão Convidar, ou a…
• Abrir um cliente Tocar num cliente em qualquer parte da aplicação abre um ecrã com o que tem, o que deve e o que está à espera: serviços com o seu estado, domínios com os dias até expirarem, faturas com as por pagar primeiro, e quaisquer tickets em aberto.…
• Substituir as definições de um cliente O ecrã de um cliente tem Permissões da aplicação, onde as predefinições podem ser substituídas só para esse cliente. Cada permissão mostra três opções: Predefinição segue a definição global, Ativado força-a disponível para este cliente seja qual for a predefinição, e Desativado retira-a…
• Publicar um problema de rede Um serviço num servidor cPanel mostra as ferramentas do cPanel em Utilização quando a conta está ativa, além de um botão Abrir cPanel. Escolher uma ferramenta inicia a sessão do cliente e, quando o servidor o permite, abre diretamente na página dessa ferramenta…
• Ler o painel O painel tem três páginas: receitas, encomendas e suporte. Deslize entre elas ou toque nos nomes acima delas, que é o caminho mais rápido para a terceira. As receitas contam o dinheiro efetivamente recebido, que não é o mesmo que o dinheiro faturado:…
• Atividade recente A Atividade recente, com ligação a partir do painel, é um fluxo único do que acabou de acontecer em todo o negócio: novas encomendas, pagamentos recebidos, tickets abertos e cancelamentos pedidos, do mais recente para o mais antigo, ao longo do último mês. Os contadores do painel dizem-lhe quantos…
• Registar um pagamento recebido Para dinheiro que chegou fora da aplicação: uma transferência bancária, numerário, um cheque. A aplicação entrega o pagamento ao WHMCS através da sua própria chamada AddInvoicePayment em vez de escrever ela própria no livro-razão, por isso é o WHMCS que decide se a fatura está agora…
• Respostas guardadas num telemóvel As respostas predefinidas já configuradas no WHMCS em Suporte aparecem na aplicação, agrupadas por categoria, e tocar numa acrescenta-a ao que já estiver na caixa de resposta em vez de o substituir. Esta é a funcionalidade que decide…
• Manter a sessão iniciada O início de sessão da equipa tem uma caixa Manter sessão iniciada neste dispositivo. Deixe-a marcada e a sessão mantém-se entre visitas como habitualmente. Desmarque-a e a sessão só se mantém até a aplicação ser totalmente fechada, o que é adequado para um…
• Impedir que um pagamento seja registado duas vezes Coloque a referência bancária ou o número do recibo no campo Referência. A aplicação recusa um segundo pagamento com uma referência já registada nessa fatura, o que o salva quando um telemóvel perde o sinal a meio do envio e toca outra vez.…
• A caixa de pesquisa O painel tem uma caixa de pesquisa que procura em clientes, faturas, tickets e domínios ao mesmo tempo, para que um cliente ao telefone possa ser encontrado sem saber em que lista está. Escreva um nome, empresa, email ou número de telefone…
• Triar um ticket Um ticket aberto na fila mostra um painel de Triagem para a equipa, por baixo do seu estado. A partir daí, o estado, a prioridade, o departamento e o membro da equipa a quem está atribuído podem ser alterados, e cada alteração produz efeito no momento em que…
• Tratar uma encomenda Tocar numa encomenda pendente abre-a com as mesmas ações que a aplicação oficial oferece, exceto uma: aceitar, cancelar, cancelar e reembolsar, marcar como fraude e voltar a pendente. Cada uma corre através da API de encomendas documentada do WHMCS, por isso faz exatamente…

Hub de suporte 4

• Abrir o hub a partir das Definições A equipa chega ao hub a partir das Definições no ecrã Você, onde Abrir Keen2Support inicia sessão no seu próprio balcão de suporte com o seu nome e email transferidos, para que não lhe voltem a ser pedidos. É uma ligação em vez…
• O feed de ajuda que o hub lê O hub não recebe a ajuda deste módulo; vai buscá-la. Uma vez por hora lê um feed que este módulo serve e guarda os artigos em cache, para que um agente de suporte a tratar um ticket os possa pesquisar e colar uma resposta…
• O que faz a ligação ao Keen2Support O Keen2Support é o seu próprio balcão de suporte, separado, com os criadores desta aplicação. A ligação regista esta aplicação no hub usando uma chave de produto obtida lá, e a aplicação recebe um token de site que usa em todos os…
• Que telemetria é enviada e qual não é A telemetria está desativada até a ativar. Quando ativa, os eventos que esta aplicação já regista no seu próprio registo de atividade são replicados para o hub: coisas como um início de sessão, um pagamento registado, um push enviado. Antes de algo sair do…

Ferramentas 2

• Verificar se o servidor consegue enviar notificações Execute «php modules/addons/whmcspwa/tools/selftest.php» no servidor. Assina um token, assina um pedido VAPID e cifra e depois decifra uma carga de push real, sem tocar na sua base de dados. Devem passar dezoito verificações. Se as de push falharem, falta ao servidor o…
• Números de versão e atualizações A versão em version.php é a única resposta verdadeira; o ecrã Visão geral, a API e a aplicação leem-na todos daí. Três ficheiros que o navegador carrega diretamente têm uma cópia para que a sua cache seja limpa na atualização. «php tools/version.php –check»…

A sua conta 8

• Alterar uma definição de domínio O ecrã de um domínio tem uma secção Definições com três interruptores que pode alterar: renovação automática, privacidade WHOIS e bloqueio de transferência. Cada um mostra o estado atual e muda ao tocar, indo diretamente para a sua conta junto do fornecedor. Renovação automática ativa…
• Alterar a sua palavra-passe Conta, Alterar palavra-passe pede a sua palavra-passe atual e depois uma nova. A palavra-passe atual é verificada primeiro, para que alguém que pegue num telemóvel desbloqueado não a possa alterar às escondidas. A nova palavra-passe tem de ter pelo menos oito…
• Editar os seus dados Conta, Os seus dados, Editar os seus dados permite-lhe alterar a sua informação de contacto: nome, empresa, email, telefone e morada. Guardar escreve diretamente na sua conta junto do fornecedor, tal como editá-la no site dele, por isso as faturas e…
• Palavra-passe esquecida No ecrã de início de sessão, Esqueci-me da palavra-passe pede um endereço de email e pede ao fornecedor que envie para ele uma ligação de reposição. A ligação e a página de reposição são do próprio sistema do fornecedor, exatamente como no site, por isso a aplicação…
• Nome de utilizador esquecido Os clientes iniciam sessão com o seu endereço de email, por isso não há um nome de utilizador separado para esquecer. Esqueci-me do nome de utilizador no ecrã de início de sessão explica isto e, se o email introduzido pertencer a uma conta, envia-lhe um breve lembrete. Tal como…
• Pagar tudo de uma vez Quando há mais de uma fatura por pagar, o ecrã inicial oferece um único botão Pagar tudo com o total combinado, ao lado de uma ligação para ver as faturas individuais. Pagar tudo abre a página de pagamento em massa do fornecedor, que liquida todas as faturas por pagar…
• Dispositivos com sessão iniciada Conta, Dispositivos com sessão iniciada lista todos os sítios onde a sua conta tem atualmente sessão iniciada, com o dispositivo, o seu endereço e quando foi usado pela última vez, e assinala aquele em que está. Terminar a sessão num dispositivo que não reconhece encerra a sua sessão…
• As suas notificações Quando as notificações estão ativadas e as permitiu num dispositivo, as coisas de que é avisado — uma nova fatura, um pagamento concluído, uma resposta a um ticket — também ficam guardadas na aplicação em…