Chaves de Licença

​

O que são Chaves de Licença?

• Licenciamento de software: Aplicativos de desktop, plugins e CLIs
• Controles por usuário: Limitar ativações por usuário ou dispositivo
• Bens digitais: Restringir downloads, atualizações ou recursos premium

​

Criar um Direito de Chave de Licença

1

Open Entitlements

Vá para Entitlements no seu painel do Dodo Payments e clique em + para criar um novo direito.

2

Choose License Key

Selecione License Key como a integração. Configure como cada chave emitida deve se comportar:

• Limite de Ativações: Máximo de ativações simultâneas por chave (por exemplo, 1 para usuário único, 5 para licenças de equipe, deixar em branco para ilimitado).
• Duração: Quanto tempo a chave permanece válida após a emissão (por exemplo, 30 dias, 1 ano). Para chaves emitidas por assinatura, deixe em branco; as chaves permanecem válidas enquanto a assinatura estiver ativa.
• Instruções de Ativação: Instruções orientadas ao cliente enviadas por e-mail com a chave. Exemplos: Paste the key in Settings → License ou Run: mycli activate <key>.

3

Save the entitlement

Salvar. O direito agora está disponível para ser anexado a qualquer produto.

​

Anexar a Produtos

​

Como as Chaves são Emitidas

​

Comportamento de Quantidade

• Produtos por assinatura emitem uma chave por assento (subscriptions.quantity).
• Produtos únicos emitem uma chave por item de linha do carrinho (product_cart.quantity).
• Concessões manuais de API emitem exatamente uma chave.

​

Modo de cumprimento

• auto (padrão): Dodo Payments gera e envia a chave automaticamente por e-mail após o pagamento ou a assinatura. Esse é o comportamento descrito acima e se aplica quando fulfillment_mode não é especificado.
• manual: a compra cria uma concessão Pending sem chave, e você fornece cada valor de chave manualmente. Consulte Atendimento manual abaixo.

​

Cumprimento Manual

​

Quando usar

• Traga suas próprias chaves: A chave é gerada por seu aplicativo, um produto de desktop ou seu próprio servidor de licenças.
• Fornecedores terceiros: Você revende chaves emitidas por um fornecedor upstream (uma chave de jogo, uma credencial de API, uma plataforma parceira).
• Inventário finito: Você distribui códigos de um pool pré-alocado e deseja atribuí-los um a um.
• Revisão humana: Você quer verificar uma compra antes de liberar o acesso.

​

Habilitar cumprimento manual

const entitlement = await client.entitlements.create({
  name: 'Pro License (Manual)',
  integration_type: 'license_key',
  integration_config: {
    fulfillment_mode: 'manual',
    activations_limit: 5,
    duration_count: 1,
    duration_interval: 'Year',
  },
});

curl -X POST https://test.dodopayments.com/entitlements \
  -H "Authorization: Bearer $DODO_PAYMENTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Pro License (Manual)",
    "integration_type": "license_key",
    "integration_config": {
      "fulfillment_mode": "manual",
      "activations_limit": 5,
      "duration_count": 1,
      "duration_interval": "Year"
    }
  }'

​

Encontrar concessões aguardando cumprimento

const pending = await client.customers.listEntitlementGrants('customer_id', {
  integration_type: 'license_key',
  status: 'Pending',
});

​

Entregar a chave

curl -X POST https://test.dodopayments.com/grants/grant_8VbC6JDZ/license-key \
  -H "Authorization: Bearer $DODO_PAYMENTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "PRO-AAAA-BBBB-CCCC-DDDD",
    "activations_limit": 5,
    "expires_at": "2027-05-01T00:00:00Z"
  }'

​

Ativação, Validação, Desativação

​

Ativar uma licença

import DodoPayments from 'dodopayments';

// No API key needed for public license endpoints
const client = new DodoPayments();

const response = await client.licenses.activate({
  license_key: 'PRO-AAAA-BBBB-CCCC-DDDD',
  name: 'Device Name',
});

console.log(response.id);

client.licenses.activate(
    license_key="PRO-AAAA-BBBB-CCCC-DDDD",
    name="Device Name",
)

curl -X POST https://test.dodopayments.com/licenses/activate \
  -H "Content-Type: application/json" \
  -d '{
    "license_key": "PRO-AAAA-BBBB-CCCC-DDDD",
    "name": "Device Name"
  }'

​

Validar uma licença

const response = await client.licenses.validate({
  license_key: 'PRO-AAAA-BBBB-CCCC-DDDD',
});

console.log(response.valid);

curl -X POST https://test.dodopayments.com/licenses/validate \
  -H "Content-Type: application/json" \
  -d '{ "license_key": "PRO-AAAA-BBBB-CCCC-DDDD" }'

​

Desativar uma instância de ativação

await client.licenses.deactivate({
  license_key: 'PRO-AAAA-BBBB-CCCC-DDDD',
  license_key_instance_id: 'instance_abc123',
});

​

Gerenciar Chaves

const grants = await client.entitlements.grants.list('ent_license_key_id', {
  status: 'Delivered',
});

for (const grant of grants.items) {
  console.log(grant.license_key.key, grant.license_key.activations_used);
}

​

Importar Chaves de Licença Existentes via API

const licenseKey = await client.licenseKeys.create({
  customer_id: 'cus_abc123',
  product_id: 'pdt_456',
  key: 'YOUR-EXISTING-LICENSE-KEY',
  activations_limit: 5,
  expires_at: '2026-12-31T23:59:59Z',
});

​

Como as chaves diferem por fonte

​

Chaves de Licença na URL de Retorno

https://yoursite.com/return?payment_id=pay_xxx&status=succeeded&license_key=LK-001&email=customer%40example.com

https://yoursite.com/return?payment_id=pay_xxx&status=succeeded&license_key=LK-001,LK-002&email=customer%40example.com

https://yoursite.com/return?subscription_id=sub_xxx&status=active&license_key=LK-001&email=customer%40example.com

​

Gerenciamento de API

​

Webhooks

​

Legacy License Keys

​

Best Practices

• Keep activation limits clear: Choose sensible defaults (1 for single-user apps, 3–5 for team licenses) and document them.
• Provide precise activation instructions: Customers paste these from their email, so exact paths and commands save support tickets.
• Validate keys server-side: For network-connected products, validate via /licenses/validate rather than caching activation locally.
• Use webhooks for revocation: Listen to entitlement_grant.revoked to disable in-app features immediately when a customer cancels or refunds.
• Test with subscriptions and one-times: License key behavior differs subtly between the two, so test both before going live.