Integrationsguide för manuell leverans av licensnycklar

• En produkt med rättigheter för licensnyckel inställd till manual leverans.
• En webhook-lyssnare som detekterar när en kund väntar på en nyckel.
• Ett leveranssamtal som levererar nyckeln och automatiskt meddelar kunden.

​

Hur det fungerar

​

Förutsättningar

• Ett Dodo Payments handlarkonto.
• Din API-nyckel (DODO_PAYMENTS_API_KEY) och hemlig webhook-nyckel från instrumentpanelen. Se Guiden för API-nyckelgenerering.
• En backend-slutpunkt som kan ta emot webhooks.

​

Steg 1 — Skapa en rättighet för licensnycklar i manuellt läge

• Dashboard
• API

1

Open Entitlements

Gå till Rättigheter i din instrumentpanel och klicka på + för att skapa en ny rättighet.

2

Choose License Key

Välj Licensnyckel som integration och ge den ett Namn. Formuläret exponerar dessa fält:

• Leveransläge — Automatic som standard. Detta är inställningen som möjliggör manuell leverans; du ändrar det i nästa steg.
• Licensens längd — hur länge varje utfärdad nyckel är giltig, eller Ingen utgång.
• Aktiveringsgräns — maximalt antal aktiveringar per nyckel, eller Obegränsat.
• Aktiveringsmeddelande — valfritt kundriktat meddelande som visas när de aktiverar nyckeln.

3

Set Fulfillment Mode to Manual

Öppna dropdown-menyn för Leveransläge och ändra från Automatisk till Manuell. Detta är inställningen som driver hela denna guide — utan den genereras och skickas nycklar automatiskt och inget väntande beviljande skapas. Med Manuell valt skapar varje köp ett pending-beviljande för dig att fullgöra. Klicka på Skapa rättighet för att spara.

Skapa rättigheten med integration_config.fulfillment_mode inställd till 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_...

​

Steg 2 — Fäst rättigheten till en produkt

​

Steg 3 — Detektera väntande beviljanden

​

Lyssna efter webhooks

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

​

Eller fråga List Grants API

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`);
}

​

Steg 4 — Leverera nyckeln

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

​

Begär fält

​

Steg 5 — Hantera fel och omförsökningar

​

Verifiera flödet

1. Köp produkten i testläge (se checkout-guiderna).
2. Bekräfta att din webhook tog emot entitlement_grant.created med status: "pending" och integration_type: "license_key", eller att beviljandet dyker upp i List Grants-svaret med dessa filter.
3. Anropa fullgörande slutpunkt med en testnyckel.
4. Bekräfta att svaret visar status: "delivered" med ett ifyllt license_key, att kunden får nyckel-e-postmeddelandet, och entitlement_grant.delivered utlöses.

​

Relaterad API-referens