Quyền lợi GitHub

​

Nội dung được cấp

• Khách hàng kết nối tài khoản GitHub của họ từ Customer Portal. Thao tác này liên kết tài khoản GitHub của họ với giao dịch mua.
• Dodo Payments mời tài khoản đó vào repository của bạn ở cấp quyền đã cấu hình. Khách hàng có quyền truy cập sau khi chấp nhận lời mời trên GitHub. Nếu khách hàng sở hữu repository thì không cần gửi lời mời.
• Việc hủy, hoàn tiền hoặc thu hồi thủ công sẽ xóa cộng tác viên và hủy mọi lời mời đang chờ.

​

Kết nối GitHub

1

Open Entitlements

Trong dashboard Dodo Payments, đi đến Entitlements và nhấp vào + để bắt đầu tạo entitlement mới.

2

Pick GitHub

Chọn GitHub Access làm integration. Nếu GitHub chưa được kết nối, hãy nhấp vào Connect GitHub.

GitHub mở trong tab mới. Đăng nhập, sau đó cài đặt Dodo Payments GitHub App trên organization hoặc tài khoản người dùng sở hữu repository. Bạn có thể cấp cho app quyền truy cập All repositories hoặc Only select repositories. Nếu chọn repository, hãy bao gồm mọi repository mà bạn dự định giới hạn quyền truy cập.

Khi GitHub chuyển hướng trở lại, một trang xác nhận cho biết tài khoản đã được kết nối.

3

Pick a Repository and Permission

Quay lại dashboard, chọn Repository mà entitlement cấp quyền truy cập, sau đó chọn cấp Permission. Trình chọn repository chỉ liệt kê những repository mà GitHub App có thể truy cập. Nhập Name cho entitlement và nhấp vào Create Entitlement.

4

Attach It to a Product

Gắn entitlement với bất kỳ product nào. Khách hàng mua product đó sẽ nhận được lời mời GitHub sau khi kết nối tài khoản GitHub của họ.

​

Các cấp quyền

​

Quy trình của khách hàng

1. Khách hàng hoàn tất checkout.
2. Dodo Payments tạo một grant ở trạng thái Pending. Dodo Payments ngay lập tức cố gắng tạo GitHub authorization URL và lưu URL đó vào oauth_url. Nếu thao tác này thất bại, oauth_url vẫn giữ giá trị null cho đến khi khách hàng bắt đầu accept flow.
3. Email xác nhận thanh toán liệt kê entitlement ở trạng thái Action Required và liên kết đến Customer Portal. Trong portal, khách hàng nhấp vào Connect và authorize bằng GitHub. Authorization link hết hạn sau 30 phút, và Customer Portal tạo một link mới khi khách hàng quay lại.
4. Dodo Payments mời GitHub account của khách hàng vào repository với permission đã được cấu hình. Grant chuyển sang Delivered ngay khi invitation được tạo. Nếu GitHub từ chối invitation, grant sẽ không được cấp.
5. Nếu subscription bị hủy, payment được refund hoặc grant bị revoke, Dodo Payments sẽ xóa khách hàng khỏi danh sách collaborator và hủy mọi invitation đang chờ.

​

Cấu hình bắt buộc

​

Tạo qua 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 được kích hoạt với status: "Pending". oauth_url có thể đã chứa GitHub authorization URL. Nếu có giá trị null, giá trị này sẽ được điền khi khách hàng bắt đầu accept flow từ Customer Portal.
• entitlement_grant.delivered được kích hoạt ngay khi collaborator invitation được tạo.
• entitlement_grant.revoked được kích hoạt khi quyền truy cập bị thu hồi. Nếu bạn uninstall GitHub App, Dodo Payments sẽ revoke các grant đang chờ và đã được cấp của installation đó bằng revocation_reason: platform_external.
• entitlement_grant.failed được kích hoạt cùng với error_code: "GRANT_ACCESS_FAILED" nếu Dodo Payments không thể thêm khách hàng vào repository, chẳng hạn vì GitHub App đã mất quyền truy cập vào repository đó.

​

Khắc phục sự cố