استحقاق GitHub

​

ما يتم تسليمه

• يربط العميل حسابه على GitHub من Customer Portal. يؤدي ذلك إلى ربط حساب GitHub الخاص به بعملية الشراء.
• يدعو Dodo Payments هذا الحساب إلى مستودعك بمستوى الأذونات المُهيأ. يحصل العميل على الوصول بعد قبول الدعوة على GitHub. إذا كان العميل يملك المستودع، فلا حاجة إلى إرسال دعوة.
• يؤدي الإلغاء أو استرداد المبلغ أو الإلغاء اليدوي إلى إزالة collaborator وإلغاء أي دعوة معلّقة.

​

الاتصال بـ GitHub

1

Open Entitlements

في لوحة معلومات Dodo Payments، انتقل إلى Entitlements وانقر على + لبدء صلاحية جديدة.

2

Pick GitHub

اختر GitHub Access باعتباره التكامل. إذا لم يكن GitHub متصلًا بعد، فانقر على Connect GitHub.

يفتح GitHub في علامة تبويب جديدة. سجّل الدخول، ثم ثبّت Dodo Payments GitHub App على المؤسسة أو حساب المستخدم الذي يملك المستودع. يمكنك منح التطبيق الوصول إلى All repositories أو Only select repositories. إذا اخترت مستودعات محددة، فأدرج كل مستودع تنوي تقييد الوصول إليه.

عندما يعيد GitHub التوجيه، تعرض صفحة تأكيد أن الحساب متصل.

3

Pick a Repository and Permission

بالعودة إلى لوحة المعلومات، حدد Repository الذي تمنح الصلاحية الوصول إليه، ثم حدد مستوى Permission. يعرض منتقي المستودعات المستودعات التي يمكن لـ GitHub App الوصول إليها فقط. أدخل Name للصلاحية وانقر على Create Entitlement.

4

Attach It to a Product

اربط الصلاحية بأي منتج. يحصل العملاء الذين يشترون هذا المنتج على دعوة GitHub بعد ربط حساب GitHub الخاص بهم.

​

مستويات الأذونات

​

مسار العميل

1. يُكمل العميل عملية الدفع.
2. ينشئ Dodo Payments منحة بالحالة Pending. يحاول Dodo Payments إنشاء عنوان URL للتفويض في GitHub فورًا، ويخزّنه في oauth_url. إذا فشلت العملية، يبقى oauth_url بالقيمة null حتى يبدأ العميل تدفق القبول.
3. يعرض البريد الإلكتروني لتأكيد الدفع الاستحقاق بالحالة Action Required ويرتبط بـ Customer Portal. في البوابة، ينقر العميل على Connect ويفوّض باستخدام GitHub. تنتهي صلاحية رابط التفويض بعد 30 دقيقة، وينشئ Customer Portal رابطًا جديدًا عند عودة العميل.
4. يرسل Dodo Payments دعوة إلى حساب GitHub الخاص بالعميل للانضمام إلى المستودع بالأذونات المُهيأة. تنتقل المنحة إلى Delivered بمجرد إنشاء الدعوة. إذا رفض GitHub الدعوة، فلا يتم تسليم المنحة.
5. إذا أُلغيت الاشتراكية، أو تم رد المبلغ، أو أُلغيت المنحة، يزيل Dodo Payments العميل بصفته متعاونًا ويلغي أي دعوة معلّقة.

​

الإعداد المطلوب

​

الإنشاء عبر API

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'],
  environment: 'test_mode',
});

const entitlement = await client.entitlements.create({
  name: 'Code Share Repository',
  integration_type: 'github',
  integration_config: {
    target_id: 'acme/private-sdk',
    permission: 'pull',
  },
});

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),
    environment="test_mode",
)

entitlement = client.entitlements.create(
    name="Code Share Repository",
    integration_type="github",
    integration_config={
        "target_id": "acme/private-sdk",
        "permission": "pull",
    },
)

// client is a *dodopayments.Client, for example from
// dodopayments.NewClient(option.WithEnvironmentTestMode()); ctx is a context.Context.
client.Entitlements.New(ctx, dodopayments.EntitlementNewParams{
  Name:            dodopayments.F("Code Share Repository"),
  IntegrationType: dodopayments.F(dodopayments.EntitlementIntegrationTypeGitHub),
  IntegrationConfig: dodopayments.F[dodopayments.IntegrationConfigUnionParam](
    dodopayments.IntegrationConfigGitHubConfigParam{
      TargetID:   dodopayments.F("acme/private-sdk"),
      Permission: dodopayments.F(dodopayments.GitHubPermissionPull),
    },
  ),
})

​

Webhooks

• يتم تشغيل entitlement_grant.created مع status: "Pending". قد يحتوي oauth_url مسبقًا على عنوان URL لتفويض GitHub. إذا كانت قيمته null، فستتم تعبئته بمجرد أن يبدأ العميل تدفق القبول من Customer Portal.
• يتم تشغيل entitlement_grant.delivered بمجرد إنشاء دعوة المتعاون.
• يتم تشغيل entitlement_grant.revoked عند سحب الوصول. إذا أزلت تثبيت GitHub App، فإن Dodo Payments يلغي المنح المعلّقة والمسلّمة الخاصة بذلك التثبيت باستخدام revocation_reason: platform_external.
• يتم تشغيل entitlement_grant.failed مع error_code: "GRANT_ACCESS_FAILED" إذا تعذّر على Dodo Payments إضافة العميل إلى المستودع، مثلًا لأن GitHub App فقد الوصول إليه.

​

استكشاف الأخطاء وإصلاحها