License Keys

​

Que sont les clés de licence ?

• Licences logicielles : applications de bureau, plugins et CLIs.
• Contrôles par siège : limiter les activations par utilisateur ou appareil.
• Produits numériques : contrôler l’accès aux téléchargements, aux mises à jour ou aux fonctionnalités premium.

​

Create a License Key Entitlement

1

Open Entitlements

Accédez à Entitlements dans le dashboard et cliquez sur + pour créer un entitlement.

2

Choose License Key

Sélectionnez License Keys, saisissez un Name, puis configurez le comportement de chaque clé émise :

• Fulfillment Mode : Automatic (par défaut) génère et envoie chaque clé par e-mail. Manual vous permet de fournir vous-même chaque clé. Consultez Manual Fulfillment.
• Activations Limit : nombre maximal d’activations actives par clé, par exemple 1 pour un utilisateur unique ou 5 pour une licence d’équipe. Sélectionnez Unlimited pour ne définir aucune limite.
• License Length : durée de validité d’une clé après son émission, par exemple 30 jours ou 1 an, ou No expiration. Pour les produits avec abonnement, choisissez No expiration : les clés émises pour un abonnement n’expirent pas et leur validité suit l’état de l’abonnement.
• Activation Message : instructions facultatives destinées au client, de 2 500 caractères maximum, incluses dans l’e-mail qui fournit la clé. Par exemple : Paste the key in Settings → License ou Run: mycli activate <key>.

3

Save the Entitlement

Cliquez sur Create Entitlement. Vous pouvez maintenant associer l’entitlement à n’importe quel produit.

​

Attach to Products

​

How Keys Are Issued

​

Comportement de la quantité

• Produits avec abonnement : une clé par siège (subscriptions.quantity).
• Produits ponctuels : une clé par unité de l’élément de ligne du panier (product_cart.quantity).
• Grants API manuels : exactement une clé.

​

Fulfillment Mode

• auto (par défaut, Automatic dans le dashboard) : Dodo Payments génère et envoie la clé par e-mail lors du paiement ou de l’abonnement. C’est le comportement présenté dans le tableau ci-dessus, et il s’applique lorsque fulfillment_mode est omis.
• manual (Manual dans le dashboard) : chaque unité achetée crée un grant Pending sans clé, et vous fournissez chaque valeur de clé. Consultez Manual Fulfillment.

​

Manual Fulfillment

​

Quand l’utiliser

• Utiliser vos propres clés : votre application, un produit de bureau ou votre propre serveur de licences génère la clé.
• Fournisseurs tiers : vous revendez des clés émises par un fournisseur en amont, comme une clé de jeu, un identifiant API ou une licence de plateforme partenaire.
• Stock limité : vous distribuez des codes provenant d’un stock préalloué et les attribuez un par un.
• Vérification humaine : vous souhaitez contrôler un achat avant d’autoriser l’accès.

​

Activer le fulfillment manuel

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

​

Trouver les grants en attente de fulfillment

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

​

Remettre la clé

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

​

Activation, validation et désactivation

​

Activer une licence

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

​

Valider une licence

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

​

Désactiver une instance d’activation

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

​

Gérer les clés

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

​

Importer des clés de licence existantes via l’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',
});

​

Différences entre les sources des clés

​

Clés de licence dans l’URL de retour

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

​

Gestion via l’API

​

Webhooks

​

Clés de licence héritées

​

Bonnes pratiques

• Choisissez des limites d’activation claires : sélectionnez des valeurs par défaut comme 1 pour les applications mono-utilisateur ou 3 à 5 pour les licences d’équipe, et documentez-les pour vos clients.
• Rédigez des messages d’activation précis : les clients les copient depuis l’e-mail de la clé de licence ; des chemins et commandes exacts évitent les demandes au support.
• Validez les clés auprès de l’API : pour les produits connectés au réseau, appelez /licenses/validate plutôt que de vous fier à une activation mise en cache localement.
• Utilisez les webhooks pour les révocations : gérez entitlement_grant.revoked afin de désactiver les fonctionnalités de l’application lorsqu’un client annule ou reçoit un remboursement.
• Testez les abonnements et les achats ponctuels : le comportement des clés de licence diffère entre les deux ; par exemple, les clés d’abonnement n’expirent pas. Testez donc les deux avant la mise en production.