GitHub Entitlement

​

Yang Diterima

• Pelanggan menghubungkan akun GitHub mereka dari Customer Portal. Ini menautkan akun GitHub mereka ke pembelian.
• Dodo Payments mengundang akun tersebut ke repository Anda pada tingkat permission yang dikonfigurasi. Pelanggan mendapatkan akses setelah menerima undangan di GitHub. Jika pelanggan memiliki repository tersebut, undangan tidak diperlukan.
• Pembatalan, refund, atau revoke manual menghapus collaborator dan membatalkan undangan yang masih tertunda.

​

Hubungkan GitHub

1

Open Entitlements

Di dashboard Dodo Payments, buka Entitlements dan klik + untuk memulai entitlement baru.

2

Pick GitHub

Pilih GitHub Access sebagai integrasi. Jika GitHub belum terhubung, klik Connect GitHub.

GitHub terbuka di tab baru. Masuk, lalu install Dodo Payments GitHub App pada organization atau user account yang memiliki repository tersebut. Anda dapat memberikan akses app ke All repositories atau Only select repositories. Jika memilih repository, sertakan setiap repository yang ingin Anda batasi aksesnya.

Saat GitHub mengarahkan kembali, halaman konfirmasi menampilkan bahwa akun telah terhubung.

3

Pick a Repository and Permission

Kembali ke dashboard, pilih Repository yang aksesnya diberikan oleh entitlement, lalu pilih tingkat Permission. Repository picker hanya menampilkan repository yang dapat diakses oleh GitHub App. Masukkan Name untuk entitlement dan klik Create Entitlement.

4

Attach It to a Product

Lampirkan entitlement ke produk mana pun. Pelanggan yang membeli produk tersebut menerima undangan GitHub setelah mereka menghubungkan akun GitHub.

​

Tingkat Permission

​

Alur Pelanggan

1. Pelanggan menyelesaikan checkout.
2. Dodo Payments membuat grant dengan status Pending. Dodo Payments segera mencoba membuat URL otorisasi GitHub dan menyimpannya di oauth_url. Jika gagal, oauth_url tetap dalam keadaan null hingga pelanggan memulai alur penerimaan.
3. Email konfirmasi pembayaran mencantumkan entitlement sebagai Action Required dan menautkan ke Customer Portal. Di portal, pelanggan mengeklik Connect dan melakukan otorisasi dengan GitHub. Tautan otorisasi kedaluwarsa setelah 30 menit, dan Customer Portal membuat tautan baru saat pelanggan kembali.
4. Dodo Payments mengundang akun GitHub pelanggan ke repository dengan izin yang telah dikonfigurasi. Grant berpindah ke Delivered setelah undangan dibuat. Jika GitHub menolak undangan tersebut, grant tidak terkirim.
5. Jika subscription dibatalkan, pembayaran dikembalikan, atau grant dicabut, Dodo Payments menghapus pelanggan sebagai collaborator dan membatalkan undangan yang masih tertunda.

​

Konfigurasi yang Diperlukan

​

Buat melalui 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 terpicu dengan status: "Pending". oauth_url mungkin sudah berisi URL otorisasi GitHub. Jika statusnya null, nilainya akan diisi setelah pelanggan memulai alur penerimaan dari Customer Portal.
• entitlement_grant.delivered terpicu setelah undangan collaborator dibuat.
• entitlement_grant.revoked terpicu saat akses dicabut. Jika Anda menghapus instalasi GitHub App, Dodo Payments mencabut grant yang masih tertunda dan yang telah dikirim dari instalasi tersebut dengan revocation_reason: platform_external.
• entitlement_grant.failed terpicu dengan error_code: "GRANT_ACCESS_FAILED" jika Dodo Payments tidak dapat menambahkan pelanggan ke repository, misalnya karena GitHub App kehilangan akses ke repository tersebut.

​

Pemecahan Masalah