Manual License Key Fulfillment Integration Guide

• A product with a License Key entitlement set to manual fulfillment.
• A webhook listener that detects when a customer is waiting for a key.
• A fulfillment call that delivers the key and notifies the customer automatically.

​

How It Works

​

Voraussetzungen

• Ein Händlerkonto bei Dodo Payments.
• Einen API-Schlüssel, der unter Developer → API Keys erstellt und in DODO_PAYMENTS_API_KEY gespeichert wird, sowie das Webhook-Signaturgeheimnis aus Developer → Webhooks, gespeichert in DODO_PAYMENTS_WEBHOOK_KEY. Siehe den Leitfaden zur API-Schlüsselerstellung.
• Einen Backend-Endpoint, der Webhooks empfangen kann.

​

Schritt 1 — Ein License Key-Entitlement im manuellen Modus erstellen

• Dashboard
• API

1

Open Entitlements

Gehe im Dashboard zu Entitlements und klicke auf +, um ein Entitlement zu erstellen.

2

Choose License Key

Wähle License Keys aus und gib einen Name ein. Das Formular enthält folgende Felder:

• Fulfillment Mode: Standardmäßig Automatic. Diese Einstellung aktiviert die manuelle Erfüllung und wird im nächsten Schritt geändert.
• License Length: Wie lange jeder ausgestellte Schlüssel gültig bleibt, oder No expiration.
• Activations Limit: Die maximale Anzahl von Aktivierungen pro Schlüssel, oder Unlimited.
• Activation Message: Eine optionale kundenorientierte Nachricht, die bei der Aktivierung des Schlüssels angezeigt und in die E-Mail mit dem Lizenzschlüssel aufgenommen wird.

3

Set Fulfillment Mode to Manual

Öffne das Dropdown Fulfillment Mode und ändere den Wert von Automatic zu Manual. Der restliche Leitfaden hängt von dieser Einstellung ab: Ohne sie generiert Dodo Payments automatisch Schlüssel, versendet sie per E-Mail und erstellt keinen ausstehenden Grant. Wenn Manual ausgewählt ist, erstellt jeder Kauf einen Pending-Grant, den du erfüllen musst. Klicke zum Speichern auf Create Entitlement.

Erstelle das Entitlement mit integration_config.fulfillment_mode, gesetzt auf 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

​

Schritt 2 — Das Entitlement einem Produkt zuweisen

​

Schritt 3 — Ausstehende Grants erkennen

​

Auf den Webhook hören

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

​

Oder die List Grants API abfragen

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

​

Schritt 4 — Den Schlüssel bereitstellen

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

​

Request-Felder

​

Schritt 5 — Fehler und Wiederholungen behandeln

​

Ablauf überprüfen

1. Kaufe das Produkt im Testmodus. Siehe die Checkout-Leitfäden.
2. Bestätige, dass dein Webhook entitlement_grant.created mit status: "Pending" und integration_type: "license_key" empfangen hat oder dass der Grant in der List Grants-Antwort erscheint, gefiltert nach status=Pending.
3. Rufe den Fulfill-Endpoint mit einem Testschlüssel auf.
4. Bestätige, dass die Antwort status: "Delivered" mit einem ausgefüllten license_key anzeigt, dass der Kunde die E-Mail mit dem Schlüssel erhält und dass entitlement_grant.delivered ausgelöst wird.

​

Verwandte API-Referenz