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 merchant-konto.
• En API key, skapad under Developer → API Keys och lagrad i DODO_PAYMENTS_API_KEY, samt webhookens signeringshemlighet från Developer → Webhooks, lagrad i DODO_PAYMENTS_WEBHOOK_KEY. Se guiden för att skapa en API key.
• En backend-endpoint som kan ta emot webhooks.

​

Steg 1 — Skapa en License Key-entitlement i manuellt läge

• Dashboard
• API

1

Open Entitlements

Gå till Entitlements i dashboarden och klicka på + för att skapa en entitlement.

2

Choose License Key

Välj License Keys och ange ett Name. Formuläret innehåller dessa fält:

• Fulfillment Mode: Automatic som standard. Detta är inställningen som aktiverar manuell leverans och du ändrar den i nästa steg.
• License Length: hur länge varje utfärdad nyckel förblir giltig, eller No expiration.
• Activations Limit: det maximala antalet aktiveringar per nyckel, eller Unlimited.
• Activation Message: ett valfritt kundmeddelande som visas när kunden aktiverar nyckeln och inkluderas i e-postmeddelandet med licensnyckeln.

3

Set Fulfillment Mode to Manual

Öppna rullgardinsmenyn Fulfillment Mode och ändra den från Automatic till Manual. Resten av den här guiden bygger på den här inställningen: utan den genererar och mejlar Dodo Payments nycklar automatiskt och skapar ingen väntande grant. När Manual är valt skapar varje köp en Pending grant som du ska leverera. Klicka på Create Entitlement för att spara.

Skapa entitlementen med integration_config.fulfillment_mode inställd på 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

​

Steg 2 — Koppla entitlementen till en produkt

​

Steg 3 — Identifiera väntande grants

​

Lyssna efter webhooken

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

​

Eller gör polling mot List Grants API

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

​

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

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 Fields

​

Steg 5 — Hantera fel och försök igen

​

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 grant visas i List Grants-svaret filtrerat efter status=Pending.
3. Anropa fulfill-endpointen med en testnyckel.
4. Bekräfta att svaret visar status: "Delivered" med ett ifyllt license_key, att kunden får e-postmeddelandet med nyckeln och att entitlement_grant.delivered utlöses.

​

Relaterad API-referens