Um sistema de chaves de licença de software para código-fonte cumpre três funções: comprova que o comprador adquiriu o produto, registra onde o produto está instalado e permite que o seu código ajuste o comportamento à edição que o comprador possui. Ele não torna impossível copiar código-fonte legível, e tentar fazer isso normalmente prejudica mais os compradores honestos do que os piratas. A abordagem que funciona melhor para a maioria dos vendedores é simples: peça a chave uma vez no instalador, verifique-a no servidor por meio de uma API de licenças, vincule-a ao domínio da instalação e depois saia do caminho.
Este guia explica como isso funciona e como adicioná-lo ao seu produto. Ele faz parte do nosso guia mais amplo sobre como vender o código-fonte do seu aplicativo web ou SaaS. Na AppTrovo, cada venda emite uma chave de licença automaticamente, com ativação por domínio e uma API de verificação de licenças, então você não precisa construir o servidor de licenciamento por conta própria, apenas a pequena verificação do lado do cliente no seu instalador.
Se você quer apenas a referência da API, vá direto ao guia de integração de licenças. Continue lendo para entender o raciocínio, as contrapartidas e um plano de testes.
O que uma chave de licença consegue realmente proteger?
Quando você vende código-fonte legível, uma pessoa determinada sempre consegue remover uma verificação de licença. Ser honesto sobre isso ajuda você a projetar algo útil em vez de algo irritante.
| Um sistema de chaves de licença pode | Um sistema de chaves de licença não pode |
|---|---|
| Confirmar que o comprador tem uma compra válida antes da instalação | Impedir que alguém apague a verificação em um código legível |
| Registrar em quais domínios uma licença está ativada | Impedir que um comprador compartilhe um arquivo ZIP |
| Informar ao seu código qual edição o comprador possui | Substituir um contrato de licença claro |
| Mostrar se o suporte e as atualizações estão ativos | Garantir o pagamento em todos os casos |
| Dar a você um registro limpo ao lidar com suporte ou disputas | Compensar um produto em que os compradores não confiam |
Pense na chave de licença como um recibo com um endereço, e não como uma fechadura. A maioria dos compradores de software empresarial é honesta e quer ficar do lado certo da licença, especialmente quando as atualizações e o suporte dependem disso. A chave torna o caminho honesto o mais fácil.
Você deve ofuscar ou codificar o seu código?
Alguns vendedores tentam proteger scripts PHP codificando-os ou ofuscando-os. Para um marketplace de código-fonte, isso geralmente é um erro:
- Os compradores pagam pelo código-fonte. O motivo pelo qual escolhem um aplicativo auto-hospedado é poder lê-lo, auditá-lo e alterá-lo. Arquivos codificados eliminam esse valor.
- Os codificadores acrescentam requisitos de hospedagem, como loaders especiais, que causam falhas de instalação e chamados.
- A ofuscação também esconde bugs de você e torna impossível a revisão de segurança por parte do comprador.
- Ela raramente impede a pirataria. Cópias piratas de produtos codificados circulam de qualquer forma.
Invista o esforço no que faz o pagamento valer a pena: atualizações, suporte, documentação e recursos da edição Commercial. É isso que uma cópia pirata nunca recebe.
Como funciona a ativação por domínio
A ativação por domínio vincula uma chave de licença aos lugares onde o produto está instalado. O fluxo na AppTrovo é assim:
- O comprador adquire o produto e recebe uma chave de licença única (um UUID).
- Durante a instalação, o seu instalador envia, a partir do servidor, a chave e o domínio da instalação para a API de verificação de licenças.
- Se a chave for válida e houver um slot de ativação livre, o domínio é registrado na licença e a resposta confirma isso.
- Executar o instalador novamente no mesmo domínio não consome outro slot.
- Se o comprador mudar para um novo servidor ou domínio, ele desativa o domínio antigo no painel e ativa o novo. Veja como gerenciar ativações de domínio.
Cada licença tem um número limitado de slots de ativação, e a resposta da verificação informa quantos estão em uso (activations_used) e disponíveis (activations_limit). Esse limite permite que o comprador rode um site de produção e uma cópia de staging sem precisar pedir a você, ao mesmo tempo que desencoraja instalações em dezenas de domínios sem relação entre si. O que a licença permite juridicamente é definido pelos termos da licença, e não pela quantidade de slots.
Verificar uma vez ou consultar o servidor continuamente?
Existem três estratégias comuns para definir quando o seu código verifica a licença. Essa escolha importa mais do que qualquer outra decisão de licenciamento, porque determina se o licenciamento pode derrubar o site de produção de um comprador.
| Estratégia | Como funciona | Risco para os compradores | Recomendação |
|---|---|---|---|
| Verificar uma vez na instalação | O instalador verifica a chave; depois disso o aplicativo funciona normalmente | Muito baixo; um problema de rede afeta apenas o instalador | Padrão recomendado |
| Nova verificação periódica | Uma tarefa agendada verifica a chave todos os dias ou toda semana | Médio; quedas, firewalls ou limites de requisições podem gerar falsas falhas | Evite, a menos que tenha um motivo forte |
| Verificar a cada requisição | Cada carregamento de página chama o servidor de licenças | Alto; deixa todas as páginas mais lentas e transforma o seu servidor em um ponto único de falha | Não use |
O guia de integração da AppTrovo recomenda verificar uma vez: depois que o instalador é concluído com sucesso, o produto grava um marcador de "instalado" e nunca mais chama a API. O aplicativo de produção de um comprador nunca deve parar de funcionar porque um servidor de licenças não pôde ser alcançado durante um problema de rede.
Como adicionar uma verificação de licença ao seu instalador
A API de verificação é uma única requisição GET para /api/v1/licenses/verify com a license_key e, opcionalmente, o seu product_slug e o domain da instalação. Enviar o slug do produto é recomendado, porque garante que a chave pertence ao seu produto e não a outro. Este é o fluxo do instalador, passo a passo:
- Peça a chave. Adicione ao seu instalador web uma etapa de licença com um único campo. O comprador não deve precisar digitar o nome de um produto nem editar arquivos de configuração; defina o slug do seu produto na sua própria configuração antes de empacotar o ZIP.
- Verifique no servidor. Chame a API a partir do seu backend com um timeout curto e a verificação SSL ativada. Nunca faça a verificação em JavaScript no navegador e nunca coloque segredos em código do lado do cliente.
- Envie o domínio. Passe o host da instalação para que a ativação seja registrada nele.
- Trate a resposta. Se
validfor verdadeiro, armazene localmente o que você precisa: a edição a partir delicense_type, o nome do licenciado e as datas de suporte, se a sua área administrativa as exibir. Se for falso, mostre ofailure_reasonem linguagem simples e deixe o comprador tentar novamente. - Marque a instalação como concluída. Grave o marcador de instalado e continue com as etapas do banco de dados e do usuário administrador. A função version_compare() do PHP também é útil mais tarde, se a sua área administrativa comparar a versão instalada com a versão mais recente. A partir daqui, nenhum código de licenciamento é executado.
Para produtos em Laravel existe um SDK de instalador pronto para usar, com um controller de instalador já feito e um pequeno middleware que apenas verifica o marcador de instalado. A lista completa de parâmetros, campos da resposta e motivos de falha está no artigo sobre a API de verificação de licenças e no guia de integração. A API tem limite de requisições (120 requisições por minuto por IP no momento em que este texto foi escrito), o que é mais um motivo para não verificar a cada requisição.
Armazene o resultado com segurança
Trate a chave de licença como qualquer outra credencial: mantenha-a fora de diretórios públicos, fora dos logs e fora do frontend. O OWASP Secrets Management Cheat Sheet traz orientações gerais sobre como lidar com chaves e tokens em aplicativos.
Libere recursos por edição, não por domínio
Os produtos da AppTrovo vêm em exatamente duas edições: uma edição Community gratuita e com recursos limitados (os compradores podem rodá-la em produção, sem suporte do autor) e uma licença Commercial paga que libera o conjunto completo de recursos. Não existe um terceiro nível. A resposta da verificação informa qual delas o comprador tem em license_type (community ou commercial, além de developer para as suas próprias chaves de teste).
- Libere recursos com base em
license_type, e não no slug do objeto da edição. O slug interno da edição Commercial é um identificador permanente que não diz "commercial", por issolicense_typeé o campo projetado para controlar o acesso aos recursos. - Armazene a edição durante a instalação na sua tabela de configurações e leia-a localmente em tempo de execução.
- Defina com clareza o que cada edição inclui e informe isso no anúncio. Limites ocultos que aparecem depois da instalação parecem uma armadilha.
A resposta também inclui product.retired. Se algum dia você descontinuar um produto, as licenças existentes continuam sendo verificadas, e a sua área administrativa pode exibir um aviso discreto de que não há mais atualizações planejadas.
Lide com desenvolvimento, staging e troca de servidores
Um licenciamento que ignora os fluxos de trabalho reais gera chamados. Planeje-se para estes casos:
- Desenvolvimento local. Os compradores primeiro instalam em
localhostou em um domínio.test. Decida se o seu instalador conta isso como uma ativação; muitos vendedores ignoram o domínio para hosts locais. - Cópias de staging. Os slots de ativação existem para que um site de staging não precise de uma segunda licença. Mencione isso na sua documentação.
- Migrações de servidor. Documente os passos: desativar o domínio antigo no painel, mover os arquivos, executar novamente a etapa de licença ou o instalador no novo domínio.
- Agências que instalam para clientes. Explique qual domínio deve ser ativado e quem deve ficar com a chave. Indique os termos da licença para uso por clientes.
Teste a sua integração antes de enviar
Você não possui uma licença paga do seu próprio produto, por isso a AppTrovo permite que todo autor gere uma licença de teste para desenvolvedor gratuita na página de edição do produto. Ela só é ativada em domínios locais, como localhost, 127.0.0.1 ou hosts terminados em .test ou .local, expira após 30 dias e pode ser prorrogada. Novos autores que ainda não têm um produto podem usar uma licença sandbox para experimentar o fluxo. Execute estes cenários:
| Cenário | Como provocá-lo | Resultado esperado |
|---|---|---|
| Chave válida, domínio novo | Instalação nova em localhost | O instalador continua e armazena a edição |
| Chave válida, mesmo domínio novamente | Executar o instalador novamente no mesmo host | O instalador continua; nenhuma ativação extra é usada |
| Nenhum slot livre | Ativar o número máximo de domínios locais e depois mais um | Mensagem clara explicando como desativar um domínio |
| Chave inválida | Digitar um UUID aleatório | Erro claro; o instalador permanece na etapa de licença |
| Chave expirada | Usar uma chave de teste expirada | Mensagem clara de "a licença expirou" |
| Falha de rede | Bloquear o host da API na sua máquina | Erro amigável com um botão para tentar novamente, e não uma página em branco |
Antes de empacotar, remova todas as flags de bypass de desenvolvimento que você adicionou durante os testes e confirme que a URL base da API aponta para a produção.
Escreva a etapa de licença pensando em pessoas
A tela de licença costuma ser a primeira coisa que o comprador vê depois de enviar os seus arquivos. Alguns detalhes a tornam amigável:
- Diga aos compradores onde encontrar a chave (para compradores da AppTrovo, na seção Licenças do painel).
- Aceite a chave com ou sem espaços ao redor e remova-os.
- Transforme os motivos de falha da API em próximos passos: "Esta chave não tem slots de ativação livres. Desative no seu painel um domínio que você não usa mais e tente novamente."
- Coloque um link para a sua página de solução de problemas de erros de licença. O nosso guia sobre documentação que reduz chamados de suporte mostra como escrever essas entradas.
Perguntas frequentes
Preciso construir meu próprio servidor de licenças para vender código?
Não na AppTrovo. Cada venda emite uma chave de licença, os compradores gerenciam as ativações de domínio no painel e você verifica as chaves por meio da API de verificação de licenças. O seu trabalho é uma pequena etapa de licença no instalador. Se você também vende no seu próprio site, vai precisar de uma solução de licenciamento separada para essas vendas.
Uma chave de licença consegue impedir a pirataria de scripts PHP?
Nenhuma verificação de licença consegue impedir totalmente que alguém edite código-fonte legível. Ela confirma compras, registra instalações e conecta os compradores às atualizações e ao suporte. A melhor resposta para a maior parte da pirataria é tornar o produto pago claramente mais valioso, com atualizações, suporte e recursos Commercial.
O que acontece se o servidor de licenças estiver fora do ar durante a instalação?
Com o padrão de verificar uma vez, apenas o instalador é afetado. Mostre um erro amigável com uma opção para tentar novamente e preserve o que o comprador digitou. Depois de instalado, o aplicativo nunca depende do servidor de licenças, então uma queda posterior não pode afetá-lo.
Como o comprador transfere a licença para um novo domínio?
Ele desativa o domínio antigo no painel, o que libera o slot de ativação, e depois executa a etapa de licença no novo domínio. Documente isso no seu guia de instalação ou de migração para que os compradores não precisem entrar em contato com você.
A edição Community deve exigir uma chave de licença?
As licenças Community também têm chaves, e a resposta da verificação as informa como community. Usar o mesmo fluxo de instalação para as duas edições mantém o seu código mais simples e permite habilitar os recursos Commercial quando o comprador adquirir depois a licença Commercial e digitar a nova chave.