Guida all'integrazione per il rilascio manuale della chiave di licenza

• Un prodotto con un diritto alla chiave di licenza impostato per manual.
• Un listener webhook che rileva quando un cliente sta aspettando una chiave.
• Una chiamata di esecuzione che consegna la chiave e notifica automaticamente il cliente.

​

Come funziona

​

Prerequisiti

• Un account merchant Dodo Payments.
• Una API key, creata in Developer → API Keys e memorizzata in DODO_PAYMENTS_API_KEY, e il webhook signing secret da Developer → Webhooks, memorizzato in DODO_PAYMENTS_WEBHOOK_KEY. Consulta la guida alla generazione delle API key.
• Un endpoint backend in grado di ricevere webhook.

​

Passaggio 1 — Crea un’entitlement License Key in modalità manuale

• Dashboard
• API

1

Open Entitlements

Vai su Entitlements nella dashboard e fai clic su + per creare un’entitlement.

2

Choose License Key

Seleziona License Keys e inserisci un Name. Il modulo contiene questi campi:

• Fulfillment Mode: Automatic per impostazione predefinita. Questa è l’impostazione che abilita il fulfillment manuale; la modificherai nel passaggio successivo.
• License Length: per quanto tempo ogni chiave emessa rimane valida, oppure No expiration.
• Activations Limit: il numero massimo di attivazioni per chiave, oppure Unlimited.
• Activation Message: un messaggio opzionale rivolto al cliente, mostrato quando il cliente attiva la chiave e incluso nell’email della license key.

3

Set Fulfillment Mode to Manual

Apri il menu a discesa Fulfillment Mode e modificalo da Automatic a Manual. Il resto di questa guida dipende da questa impostazione: senza di essa, Dodo Payments genera e invia automaticamente le chiavi via email e non crea alcun grant in attesa. Con Manual selezionato, ogni acquisto crea un grant Pending da completare. Fai clic su Create Entitlement per salvare.

Crea l’entitlement con integration_config.fulfillment_mode impostato su 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

​

Passaggio 2 — Associa l’entitlement a un prodotto

​

Passaggio 3 — Rileva i grant in attesa

​

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

​

In alternativa, esegui il polling dell’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"

​

Passaggio 4 — Consegna la chiave

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

​

Campi della richiesta

​

Passaggio 5 — Gestisci errori e retry

​

Verifica il flusso

1. Acquista il prodotto in modalità di test. Consulta le guide al checkout.
2. Verifica che il webhook abbia ricevuto entitlement_grant.created con status: "Pending" e integration_type: "license_key", oppure che il grant compaia nella risposta List Grants filtrata per status=Pending.
3. Chiama l’endpoint fulfill con una chiave di test.
4. Verifica che la risposta mostri status: "Delivered" con license_key valorizzato, che il cliente riceva l’email con la chiave e che entitlement_grant.delivered venga attivato.

​

Riferimenti API correlati