License Keys

​

Vad är licensnycklar?

• Programvarulicenser: skrivbordsappar, plugins och CLI:er.
• Platsbaserade kontroller: begränsa aktiveringar per användare eller enhet.
• Digitala varor: begränsa åtkomst till hämtningar, uppdateringar eller premiumfunktioner.

​

Create a License Key Entitlement

1

Open Entitlements

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

2

Choose License Key

Välj License Keys, ange ett Name och konfigurera hur varje utfärdad nyckel ska fungera:

• Fulfillment Mode: Automatic (standard) genererar och skickar varje nyckel via e-post. Manual låter dig ange varje nyckel själv. Se Manual Fulfillment.
• Activations Limit: det maximala antalet aktiva aktiveringar per nyckel, till exempel 1 för en enskild användare eller 5 för en teamlicens. Välj Unlimited om ingen gräns ska gälla.
• License Length: hur länge en nyckel förblir giltig efter att den utfärdats, till exempel 30 dagar eller 1 år, eller No expiration. För prenumerationsprodukter väljer du No expiration: nycklar som utfärdas för en prenumeration löper inte ut, och deras giltighet följer prenumerationens status.
• Activation Message: valfria instruktioner riktade till kunden, upp till 2 500 tecken, som inkluderas i e-postmeddelandet där nyckeln levereras. Till exempel: Paste the key in Settings → License eller Run: mycli activate <key>.

3

Save the Entitlement

Klicka på Create Entitlement. Du kan nu koppla entitlementet till valfri produkt.

​

Attach to Products

​

How Keys Are Issued

​

Beteende för antal

• Prenumerationsprodukter utfärdar en nyckel per plats (subscriptions.quantity).
• Engångsprodukter utfärdar en nyckel per enhet i kundvagnens radartikel (product_cart.quantity).
• Manuella API-grants utfärdar exakt en nyckel.

​

Fulfillment Mode

• auto (standard, Automatic i dashboarden): Dodo Payments genererar och skickar nyckeln via e-post vid betalning eller prenumeration. Detta är beteendet i tabellen ovan och gäller när fulfillment_mode utelämnas.
• manual (Manual i dashboarden): varje köpt enhet skapar ett Pending-grant utan nyckel, och du anger varje nyckelvärde. Se Manual Fulfillment.

​

Manual Fulfillment

​

När ska det användas?

• Använd dina egna nycklar: din applikation, en skrivbordsprodukt eller din egen licensserver genererar nyckeln.
• Tredjepartsleverantörer: du säljer vidare nycklar som utfärdas av en överordnad leverantör, till exempel en spelnyckel, en API-uppgift eller en partnerplattformens licens.
• Begränsat lager: du delar ut koder från en förallokerad pool och tilldelar dem en i taget.
• Manuell granskning: du vill kontrollera ett köp innan du ger åtkomst.

​

Aktivera manuell fulfillment

// `client` is a DodoPayments instance created with your API key.
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',
  },
});

curl -X POST https://test.dodopayments.com/entitlements \
  -H "Authorization: Bearer $DODO_PAYMENTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Pro License (Manual)",
    "integration_type": "license_key",
    "integration_config": {
      "fulfillment_mode": "manual",
      "activations_limit": 5,
      "duration_count": 1,
      "duration_interval": "Year"
    }
  }'

​

Hitta grants som väntar på fulfillment

const pending = await client.customers.listEntitlementGrants('cus_abc123', {
  integration_type: 'license_key',
  status: 'Pending',
});

​

Leverera nyckeln

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

​

Aktivering, validering och inaktivering

​

Aktivera en licens

import DodoPayments from 'dodopayments';

// The license endpoints don't check the token, but the SDK requires a value.
// Never ship your secret API key in client software.
const client = new DodoPayments({ bearerToken: 'public', environment: 'test_mode' });

const response = await client.licenses.activate({
  license_key: 'PRO-AAAA-BBBB-CCCC-DDDD',
  name: 'Device Name',
});

console.log(response.id);

from dodopayments import DodoPayments

# The license endpoints don't check the token, but the SDK requires a value.
client = DodoPayments(bearer_token="public", environment="test_mode")

response = client.licenses.activate(
    license_key="PRO-AAAA-BBBB-CCCC-DDDD",
    name="Device Name",
)
print(response.id)

curl -X POST https://test.dodopayments.com/licenses/activate \
  -H "Content-Type: application/json" \
  -d '{
    "license_key": "PRO-AAAA-BBBB-CCCC-DDDD",
    "name": "Device Name"
  }'

​

Validera en licens

// Uses the client from the activation example.
const response = await client.licenses.validate({
  license_key: 'PRO-AAAA-BBBB-CCCC-DDDD',
});

console.log(response.valid);

curl -X POST https://test.dodopayments.com/licenses/validate \
  -H "Content-Type: application/json" \
  -d '{ "license_key": "PRO-AAAA-BBBB-CCCC-DDDD" }'

​

Inaktivera en aktiveringsinstans

await client.licenses.deactivate({
  license_key: 'PRO-AAAA-BBBB-CCCC-DDDD',
  license_key_instance_id: 'lki_abc123',
});

​

Hantera nycklar

const grants = await client.entitlements.grants.list('ent_license_key_id', {
  status: 'Delivered',
});

for (const grant of grants.items) {
  console.log(grant.license_key?.key, grant.license_key?.activations_used);
}

​

Importera befintliga licensnycklar via API

const licenseKey = await client.licenseKeys.create({
  customer_id: 'cus_abc123',
  product_id: 'pdt_456',
  key: 'YOUR-EXISTING-LICENSE-KEY',
  activations_limit: 5,
  expires_at: '2026-12-31T23:59:59Z',
});

​

Hur nycklar skiljer sig beroende på källa

​

Licensnycklar i return-URL:en

https://yoursite.com/return?payment_id=pay_xxx&status=succeeded&license_key=LK-001&email=customer%40example.com

https://yoursite.com/return?payment_id=pay_xxx&status=succeeded&license_key=LK-001%2CLK-002&email=customer%40example.com

https://yoursite.com/return?subscription_id=sub_xxx&status=active&license_key=LK-001&email=customer%40example.com

​

API-hantering

​

Webhooks

​

Äldre licensnycklar

​

Bästa praxis

• Välj tydliga aktiveringsgränser: välj standardvärden som 1 för appar för enskilda användare eller 3–5 för teamlicenser och dokumentera dem för dina kunder.
• Skriv tydliga aktiveringsmeddelanden: kunder kopierar dem från e-postmeddelandet med licensnyckeln, så exakta sökvägar och kommandon förebygger supportärenden.
• Validera nycklar mot API:t: för nätverksanslutna produkter anropar du /licenses/validate i stället för att förlita dig på en lokalt cachad aktivering.
• Använd webhooks för återkallning: hantera entitlement_grant.revoked för att inaktivera funktioner i appen när en kund avslutar eller får en återbetalning.
• Testa prenumerationer och engångsköp: licensnycklars beteende skiljer sig mellan dessa, till exempel löper prenumerationsnycklar inte ut, så testa båda innan du går live.