Licensnycklar är av entitetstypen Licensnyckel. Skapa en licensnyckel-entitet en gång med den aktiveringsgräns, utgångsdatum och instruktioner du önskar, koppla den till vilken produkt som helst, och Dodo Payments genererar och levererar en nyckel per köp eller prenumerationsplats, automatiskt.
Vad är Licensnycklar?
Licensnycklar är unika token som auktoriserar åtkomst till din produkt. De är idealiska för:- Programvarulicensering: Skrivbordsappar, plugins och CLIs
- Per-användarkontroller: Begränsa aktiveringar per användare eller enhet
- Digitala varor: Stänga av nedladdningar, uppdateringar eller premiumfunktioner
Skapa en Licensnyckel Entitlement
1
Open Entitlements
Gå till Entitlements i din Dodo Payments-instrumentpanel och klicka på + för att skapa en ny entitlement.
2
Choose License Key
Välj License Key som integration. Konfigurera hur varje utfärdad nyckel beter sig:
- Aktiveringsbegränsningar: Maximalt antal samtidiga aktiveringar per nyckel (t.ex.,
1för enanvändarlicens,5för teamlicenser, lämna tom för obegränsat). - Varaktighet: Hur lång tid nyckeln förblir giltig efter utfärdande (t.ex., 30 dagar, 1 år). För prenumerationsutgivna nycklar, lämna tom; nycklar förblir giltiga så länge prenumerationen är aktiv.
- Aktiveringsinstruktioner: Kundanvisningar som skickas med nyckeln till e-post. Exempel:
Paste the key in Settings → LicenseellerRun: mycli activate <key>.

3
Save the entitlement
Spara. Entitlement är nu tillgänglig att koppla till vilken produkt som helst.
Koppla till Produkter
Öppna en produkt, expandera Avancerade inställningar → Entitlements & Credits, och välj din Licensnyckel-entitlement. En enskild produkt kan leverera en licensnyckel tillsammans med andra entitlements (Discord-åtkomst, filnedladdningar, GitHub-repoåtkomst, etc.) vid samma köp.
Hur nycklar utfärdas
Nyckelutfärdande följer standarden grant lifecycle:Kvantitetsbeteende
- Prenumerationsprodukter utfärdar en nyckel per plats (
subscriptions.quantity). - Engångsprodukter utfärdar en nyckel per kassaartikel (
product_cart.quantity). - Manuella API-beviljanden utfärdar exakt en nyckel.
Aktivering, Validering, Inaktivering
API-slutpunkterna för aktivering/validering/inaktivering är offentliga och kräver ingen API-nyckel. Använd dem direkt från skrivbordsprogramvara, CLI:er eller webbläsarbaserade klienter för att verifiera nycklar vid körning.Offentliga Slutpunkter: Aktivera, inaktivera och validera licensslutpunkterna är offentliga och kräver ingen API-nyckel. Anropa dem direkt från dina klientapplikationer utan att exponera dina API-uppgifter.
Aktivera en licens
Validera en licens
Inaktivera en aktiveringsinstans
Hantera Nycklar
När en kund köper en produkt i manuellt läge skapas beviljandet ipending-status utan nyckel och en entitlement_grant.created webhook utlöses med integration_type: "license_key" och status: "pending". Du kan reagera på den webbhooken, eller undersöka List Customer Grants endpointen med integration_type och status filter:
Importera Befintliga Licensnycklar via API
Har du redan licensnycklar i ett annat system? Använd Create License Key API för att importera dem till Dodo Payments. Detta låter dig migrera befintliga nycklar utan att störa dina kunder – de fortsätter att aktivera, validera och inaktivera mot samma nyckelsträngar utan återskapande.Skillnaden mellan importerade och automatgenererade nycklar
Använd
source-fältet på GET /license_keys-svar för att särskilja migrerat lager från organiskt utfärdade nycklar vid avstämning eller revision.
Licensnycklar i Return URL
När en kund slutför ett köp för en produkt med en Licensnyckel-entitlement, läggs den genererade nyckeln automatiskt till dinreturn_url som en frågeparameter. Detta låter dig visa nyckeln omedelbart på din nätsida utan att göra en extra API-anrop.
subscription_id istället för payment_id:
API-hantering
Lifecycle Operations (Public Endpoints)
Lifecycle Operations (Public Endpoints)
Aktivering, inaktivering, och validering är offentliga; ingen API-nyckel krävs.
Activate License
Skapa eller registrera en aktiveringsinstans för en licensnyckel.
Deactivate License
Återkalla en tidigare aktivering för att frigöra kapacitet.
Validate License
Kontrollera äkthet, status och begränsningar innan du beviljar åtkomst.
License Key Management
License Key Management
Skapa, lista, hämta och uppdatera individuella licensnyckelregister. Använd dessa för att importera befintliga nycklar eller hämta användningsdetaljer.
Create License Key
Skapa en ny licensnyckel eller importera en befintlig.
Get License Key
Hämta en specifik nyckel och dess metadata.
Update License Key
Ändra utgång, aktiveringsgränser, eller aktivera/inaktivera en nyckel.
Entitlement Management
Entitlement Management
Hantera själva Licensnyckel-entitlement: dess aktiveringsgräns, varaktighet och instruktioner.
Create Entitlement
Skapa en Licensnyckel-entitlement.
Update Entitlement
Uppdatera entitlement-konfigurationen.
List Grants
Lista nycklarna som utfärdats för en entitlement.
Revoke Grant
Återkalla manuellt en kunds nyckel.
Webhooks
Leverans och återkallande av licensnycklar utlöser de fyraentitlement_grant.* webhook-händelserna. Grant-payloaden inkluderar ett fyllt license_key-objekt med nyckeln, utgång, använda aktiveringar och gräns.
De äldre license_key.*-händelserna (license_key.created) fortsätter att avfyras för den underliggande licensnyckelns registerlivscykel; se sidan License Key webhook payload.
Äldre Licensnycklar
Produkter skapade med den äldre
license_key_enabled-flaggan har blivit automatiskt migrerade till en Licensnyckel-entitlement. Migrationen är transparent: befintliga kunders nycklar fortsätter att fungera oförändrade, den offentliga /licenses/activate, /licenses/validate, /licenses/deactivate-slutpunkterna fortsätter att fungera, och /license_keys/* API-slutpunkterna fortsätter att läsa och skriva till samma nyckellager.Den fristående License Keys instrumentpanelssektionen förblir tillgänglig som en platt lista över varje utfärdad nyckel, användbar för revision och sökning. Nya konfigurationer (ändring av aktiveringsgränser, varaktigheter eller instruktioner) bör göras genom att redigera den migrerade Licensnyckel-entitlement under Entitlements.Bästa Praxisen
- Håll aktiveringsgränserna klara: Välj rimliga standardvärden (1 för enanvändarappar, 3–5 för teamlicenser) och dokumentera dem.
- Ge precisa aktiveringsinstruktioner: Kunder klistrar in dessa från sina mejl, så exakta vägar och kommandon sparar supportärenden.
- Validera nycklar server-side: För nätverksanslutna produkter, validera via
/licenses/validateistället för att cachea aktivering lokalt. - Använd webhooks för återkallelse: Lyssna på
entitlement_grant.revokedför att omedelbart inaktivera in-app funktioner när en kund avbokar eller får återbetalning. - Testa med prenumerationer och engångstillfällen: Licensnyckelbeteende skiljer sig subtilt mellan de två, så testa båda innan du startar.
API-Management
Lifecycle Operations (Public Endpoints)
Lifecycle Operations (Public Endpoints)
Aktivering, avaktivering och validering är offentliga; ingen API-nyckel krävs.
Activate License
Skapa eller registrera en aktiveringsinstans för en licensnyckel.
Deactivate License
Återkalla en tidigare aktivering för att frigöra kapacitet.
Validate License
Kontrollera äkthet, status och begränsningar innan åtkomst beviljas.
License Key Management
License Key Management
Skapa, lista, hämta och uppdatera enskilda licensnyckelposter. Använd dessa för att importera befintliga nycklar eller hämta användningsinformation.
Create License Key
Skapa en ny licensnyckel eller importera en befintlig.
List License Keys
Bläddra i alla nycklar med status och användningsinformation.
Get License Key
Hämta en specifik nyckel och dess metadata.
Update License Key
Modifiera utgång, aktiveringsgränser eller aktivera/inaktivera en nyckel.
Entitlement Management
Entitlement Management
Hantera själva licensnyckelrätten: dess aktiveringsgräns, varaktighet och instruktioner.
Create Entitlement
Skapa en licensnyckelrättighet.
Update Entitlement
Uppdatera rättighetens konfiguration.
List Grants
Lista nycklar som utfärdats för en rättighet.
Revoke Grant
Manuellt återkalla en kunds nyckel.
Webbhooks
Leverans och återkallande av licensnycklar utlöser de fyraentitlement_grant.* webhook-händelserna. Beviljandedatan innehåller ett ifyllt license_key-objekt med nyckel, utgång, användningsaktiveringar och gräns.
De äldre license_key.*-händelserna (license_key.created) fortsätter att utlösas för licensnyckelns livscykel; se Licensnyckelns webhook-dataplast.
Legacy Licensnycklar
Produkter skapade med den äldre
license_key_enabled-flaggan har automatiskt migrerats till en licensnyckelrätt. Migreringen är transparent: befintliga kunders nycklar fortsätter att fungera oförändrade, de offentliga /licenses/activate, /licenses/validate, /licenses/deactivate-ändpunkterna fortsätter att fungera, och /license_keys/* API-ändpunkterna fortsätter att läsa och skriva till samma nyckellager.Den fristående Licensnycklar-dashboardsektionen finns kvar som en platt lista över varje utfärdad nyckel, användbar för revision och sökning. Ny konfiguration (ändra aktiveringsgränser, varaktigheter eller instruktioner) bör göras genom att redigera den migrerade licensnyckelrättigheten under Rättigheter.Best Practices
- Håll aktiveringsgränser tydliga: Välj rimliga standardvärden (1 för enanvändarappar, 3–5 för teamlicenser) och dokumentera dem.
- Ge precisa aktiveringsinstruktioner: Kunder klistrar in dessa från sin e-post, så exakta sökvägar och kommandon sparar supportärenden.
- Validera nycklar server-sida: För nätverksanslutna produkter, validera via
/licenses/validateistället för att cachea aktiveringen lokalt. - Använd webhooks för återkallande: Lyssna på
entitlement_grant.revokedför att omedelbart inaktivera appfunktioner när en kund avbryter eller återbetalar. - Testa med prenumerationer och engångsköp: Licensnyckelbeteendet skiljer sig subtilt mellan de två, så testa båda innan de tas i bruk.