مفاتيح التراخيص

​

ما هي مفاتيح الترخيص؟

• ترخيص البرامج: تطبيقات سطح المكتب والإضافات وCLIs.
• عناصر التحكم لكل مقعد: تقييد عمليات التفعيل لكل مستخدم أو جهاز.
• المنتجات الرقمية: تقييد الوصول إلى التنزيلات أو التحديثات أو الميزات المميزة.

​

إنشاء استحقاق License Key

1

Open Entitlements

انتقل إلى Entitlements في لوحة التحكم وانقر على + لإنشاء entitlement.

2

Choose License Key

حدّد License Keys، وأدخل Name، واضبط كيفية تصرف كل مفتاح يتم إصداره:

• Fulfillment Mode: ينشئ Automatic (الإعداد الافتراضي) كل مفتاح ويرسله عبر البريد الإلكتروني. يتيح لك Manual توفير كل مفتاح بنفسك. راجع Manual Fulfillment.
• Activations Limit: الحد الأقصى لعدد عمليات التفعيل النشطة لكل مفتاح، مثل 1 لمستخدم واحد أو 5 لترخيص فريق. حدّد Unlimited لعدم فرض حد.
• License Length: المدة التي يظل فيها المفتاح صالحًا بعد إصداره، مثل 30 يومًا أو سنة واحدة، أو No expiration. بالنسبة إلى المنتجات القائمة على الاشتراك، اختر No expiration: لا تنتهي صلاحية المفاتيح الصادرة لاشتراك، وتتبع صلاحيتها حالة الاشتراك.
• Activation Message: تعليمات اختيارية موجّهة إلى العميل، بحد أقصى 2,500 حرف، تُضمّن في البريد الإلكتروني الذي يسلّم المفتاح. مثال: Paste the key in Settings → License أو Run: mycli activate <key>.

3

Save the Entitlement

انقر على Create Entitlement. يمكنك الآن إرفاق entitlement بأي منتج.

​

إرفاق الاستحقاق بالمنتجات

​

كيفية إصدار المفاتيح

​

سلوك الكمية

• المنتجات القائمة على الاشتراك: تصدر مفتاحًا واحدًا لكل مقعد (subscriptions.quantity).
• المنتجات لمرة واحدة: تصدر مفتاحًا واحدًا لكل وحدة من عنصر السطر في سلة التسوق (product_cart.quantity).
• المنح اليدوية عبر API: تصدر مفتاحًا واحدًا بالضبط.

​

Fulfillment Mode

• auto (الإعداد الافتراضي، Automatic في لوحة التحكم): ينشئ Dodo Payments المفتاح ويرسله عبر البريد الإلكتروني عند الدفع أو الاشتراك. هذا هو السلوك الموضح في الجدول أعلاه، وينطبق عند حذف fulfillment_mode.
• manual (Manual في لوحة التحكم): ينشئ كل عنصر يتم شراؤه منحة Pending بلا مفتاح، وعليك توفير قيمة كل مفتاح. راجع Manual Fulfillment.

​

Manual Fulfillment

​

متى تستخدمه؟

• استخدام مفاتيحك الخاصة: ينشئ تطبيقك أو منتج سطح المكتب أو خادم الترخيص الخاص بك المفتاح.
• المورّدون الخارجيون: تعيد بيع مفاتيح يصدرها مزود أصلي، مثل مفتاح لعبة أو بيانات اعتماد API أو ترخيص منصة شريكة.
• المخزون المحدود: توزع رموزًا من مجموعة مخصصة مسبقًا وتعيّنها واحدًا تلو الآخر.
• المراجعة البشرية: تريد التحقق من عملية شراء قبل منح الوصول.

​

تفعيل التوفير اليدوي

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

​

العثور على المنح التي تنتظر التوفير

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

​

تسليم المفتاح

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

​

تفعيل الترخيص والتحقق منه وإلغاء تفعيله

​

تفعيل ترخيص

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

​

التحقق من ترخيص

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

​

إلغاء تفعيل مثيل تفعيل

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

​

إدارة المفاتيح

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

​

استيراد مفاتيح الترخيص الحالية عبر 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',
});

​

كيف تختلف المفاتيح حسب المصدر؟

​

مفاتيح الترخيص في Return URL

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

​

Webhooks

​

مفاتيح الترخيص القديمة

​

أفضل الممارسات

• اختر حدود تفعيل واضحة: اختر إعدادات افتراضية مثل 1 لتطبيقات المستخدم الواحد أو 3–5 لتراخيص الفرق، ووثّقها لعملائك.
• اكتب رسائل تفعيل دقيقة: ينسخها العملاء من البريد الإلكتروني لمفتاح الترخيص، لذا تمنع المسارات والأوامر الدقيقة تذاكر الدعم.
• تحقق من المفاتيح مقابل API: بالنسبة إلى المنتجات المتصلة بالشبكة، استدعِ /licenses/validate بدلًا من الاعتماد على تفعيل مخزّن محليًا.
• استخدم webhooks للإلغاء: عالج entitlement_grant.revoked لتعطيل الميزات داخل التطبيق عندما يلغي العميل أو يسترد أمواله.
• اختبر الاشتراكات وعمليات الشراء لمرة واحدة: يختلف سلوك مفتاح الترخيص بينهما؛ فمثلًا لا تنتهي صلاحية مفاتيح الاشتراك، لذا اختبر كليهما قبل الإطلاق.