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.
• Uma API key, criada em Developer → API Keys e armazenada em DODO_PAYMENTS_API_KEY, além do segredo de assinatura do webhook, obtido em Developer → Webhooks e armazenado em DODO_PAYMENTS_WEBHOOK_KEY. Consulte o guia de geração de API key.
• Um endpoint de backend que possa receber webhooks.

​

Etapa 1 — Criar um entitlement de License Key no modo manual

• Dashboard
• API

1

Open Entitlements

Acesse Entitlements no dashboard e clique em + para criar um entitlement.

2

Choose License Key

Selecione License Keys e informe um Name. O formulário tem estes campos:

• Fulfillment Mode: Automatic por padrão. Essa é a configuração que habilita o preenchimento manual, e você a altera na próxima etapa.
• License Length: por quanto tempo cada chave emitida permanece válida, ou No expiration.
• Activations Limit: o número máximo de ativações por chave, ou Unlimited.
• Activation Message: uma mensagem opcional voltada ao cliente, exibida quando o cliente ativa a chave e incluída no e-mail da chave de licença.

3

Set Fulfillment Mode to Manual

Abra o menu suspenso Fulfillment Mode e altere de Automatic para Manual. O restante deste guia depende dessa configuração: sem ela, o Dodo Payments gera e envia as chaves automaticamente por e-mail e não cria nenhum grant pendente. Com Manual selecionado, cada compra cria um grant Pending para você preencher. Clique em Create Entitlement para salvar.

Crie o entitlement com integration_config.fulfillment_mode definido 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_...

See all 19 lines

​

Etapa 2 — Associar o entitlement a um produto

​

Etapa 3 — Detectar grants pendentes

​

Aguardar o webhook

import { Webhook } from 'standardwebhooks';

const webhook = new Webhook(process.env.DODO_PAYMENTS_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'
  ) {
    // queueLicenseKeyFulfillment is your own job queue, not part of the SDK.
    await queueLicenseKeyFulfillment({
      grantId: event.data.id,
      customerId: event.data.customer_id,
    });
  }

  return new Response('ok');
}

​

Ou consultar a API List Grants

// Uses the client from Step 1.
const pending = await client.entitlements.grants.list('ent_license_key_id', {
  status: 'Pending',
});

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

curl -G https://test.dodopayments.com/entitlements/ent_license_key_id/grants \
  -H "Authorization: Bearer $DODO_PAYMENTS_API_KEY" \
  --data-urlencode "status=Pending"

​

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"
}

curl -X POST https://test.dodopayments.com/grants/entg_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"
  }'

​

Campos da solicitação

​

Etapa 5 — Lidar com erros e novas tentativas

​

Verificar o fluxo

1. Compre o produto no modo de teste. Consulte os guias de checkout.
2. Confirme que seu webhook recebeu entitlement_grant.created com status: "Pending" e integration_type: "license_key", ou que o grant aparece na resposta de List Grants filtrada por status=Pending.
3. Chame o endpoint de preenchimento com uma chave de teste.
4. Confirme que a resposta mostra status: "Delivered" com um license_key preenchido, que o cliente recebe o e-mail com a chave e que entitlement_grant.delivered é disparado.

​

Referência relacionada da API