Guia de Integração para Cumprimento Manual de Chaves de Licença

• Um produto com uma autorização de Chave de Licença definida para cumprimento manual.
• Um ouvinte de webhook que detecta quando um cliente está aguardando uma chave.
• Uma chamada de cumprimento que entrega a chave e notifica o cliente automaticamente.

​

Como Funciona

​

Pré-requisitos

• Uma conta de comerciante do Dodo Payments.
• Sua chave de API (DODO_PAYMENTS_API_KEY) e a chave secreta do webhook do painel de controle. Veja o guia de geração de chave de API.
• Um endpoint de backend que possa receber webhooks.

​

Etapa 1 — Criar uma Autorização de Chave de Licença no Modo Manual

• Dashboard
• API

1

Open Entitlements

Vá para Autorizations no seu painel e clique em + para criar uma nova autorização.

2

Choose License Key

Selecione Chave de Licença como a integração e dê um Nome. O formulário expõe esses campos:

• Modo de Cumprimento — Automatic por padrão. Esta é a configuração que habilita o cumprimento manual; você a altera no próximo passo.
• Duração da Licença — quanto tempo cada chave emitida permanece válida, ou Sem expiração.
• Limite de Ativações — máximo de ativações por chave, ou Ilimitado.
• Mensagem de Ativação — mensagem opcional voltada ao cliente exibida quando ele ativa a chave.

3

Set Fulfillment Mode to Manual

Abra o dropdown Modo de Cumprimento e altere de Automático para Manual. Esta é a configuração que conduz todo este guia — sem ela, as chaves são geradas e enviadas por e-email automaticamente e nenhuma concessão pendente é criada. Com Manual selecionado, cada compra cria uma concessão pending para você cumprir. Clique em Criar Autorização para salvar.

Crie a autorização com integration_config.fulfillment_mode definida como manual.

Node.js

Python

cURL

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
  environment: 'test_mode', // defaults to 'live_mode'
});

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',
  },
});

console.log(entitlement.id); // ent_...

​

Etapa 2 — Anexe a Autorização a um Produto

​

Etapa 3 — Detectar Concessões Pendentes

​

Ouça o webhook

import { Webhook } from 'standardwebhooks';

const webhook = new Webhook(process.env.DODO_WEBHOOK_KEY!);

export async function POST(request: Request) {
  const rawBody = await request.text();
  const headers = {
    'webhook-id': request.headers.get('webhook-id') || '',
    'webhook-signature': request.headers.get('webhook-signature') || '',
    'webhook-timestamp': request.headers.get('webhook-timestamp') || '',
  };

  await webhook.verify(rawBody, headers);
  const event = JSON.parse(rawBody);

  // A customer bought a manual-mode license key and is waiting for it.
  if (
    event.type === 'entitlement_grant.created' &&
    event.data.integration_type === 'license_key' &&
    event.data.status === 'pending'
  ) {
    await queueLicenseKeyFulfillment({
      grantId: event.data.id,
      customerId: event.data.customer_id,
    });
  }

  return new Response('ok');
}

​

Ou faça polling da API de Listagem de Concessões

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

for (const grant of pending.items) {
  console.log(`Grant ${grant.id} for customer ${grant.customer_id} needs a key`);
}

​

Etapa 4 — Entregar a Chave

async function fulfill(grantId: string, key: string) {
  const res = await fetch(
    `https://test.dodopayments.com/grants/${grantId}/license-key`,
    {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
        Authorization: `Bearer ${process.env.DODO_PAYMENTS_API_KEY}`,
      },
      body: JSON.stringify({
        key,
        // Optional — fall back to the entitlement config when omitted
        activations_limit: 5,
        expires_at: '2027-05-01T00:00:00Z',
      }),
    },
  );

  if (!res.ok) {
    // See the status code table below for handling
    throw new Error(`Fulfillment failed: ${res.status}`);
  }

  return res.json(); // updated grant, now status: "delivered"
}

​

Campos de solicitação

​

Etapa 5 — Lidando com Erros e Novas Tentativas

​

Verifique o Fluxo

1. Compre o produto em modo de teste (veja os guias de checkout).
2. Confirme se seu webhook recebeu entitlement_grant.created com status: "pending" e integration_type: "license_key", ou se a concessão aparece na resposta da Listagem de Concessões com esses filtros.
3. Chame o endpoint de cumprimento com uma chave de teste.
4. Confirme se a resposta mostra status: "delivered" com um license_key preenchido, o cliente recebe o e-mail da chave e entitlement_grant.delivered dispara.

​

Referência de API Relacionada