Quyền lợi GitHub

Cấp cho khách hàng quyền cộng tác viên trên một repository GitHub riêng tư ở cấp quyền bạn chọn và tự động thu hồi khi hủy.

Quyền lợi GitHub thêm khách hàng trả phí làm cộng tác viên trên một repository riêng tư. Bạn chọn cấp quyền (pull, push, triage, maintain hoặc admin) và Dodo Payments xử lý lời mời, theo dõi việc chấp nhận và xóa quyền khi hủy.

​

Nội dung được cung cấp

• Khách hàng được mời vào repository GitHub của bạn thông qua OAuth flow liên kết tài khoản GitHub của họ với giao dịch mua.
• Sau khi chấp nhận, GitHub cấp cho họ quyền cộng tác viên ở cấp quyền đã cấu hình.
• Khi hủy, hoàn tiền hoặc thu hồi thủ công, cộng tác viên sẽ bị xóa.

Các trường hợp sử dụng phổ biến gồm sản phẩm có mã nguồn cung cấp, template trả phí, repository mã nguồn khóa học và SDK client giới hạn quyền truy cập.

​

Kết nối GitHub

1. Open Entitlements

   Trong dashboard Dodo Payments của bạn, đi đến Entitlements và nhấp + để 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, bạn sẽ được nhắc Connect GitHub.

   

   Connect GitHub prompt before the install handoff.

   Nhấp để tiếp tục sẽ mở GitHub trong tab mới. Đăng nhập, sau đó cài đặt GitHub App của Dodo Payments trên tổ chức hoặc tài khoản người dùng sở hữu repository. Bạn có thể cấp quyền truy cập cho all repositories hoặc chỉ những repository bạn muốn giới hạn quyền truy cập.

   

   GitHub Install & Authorize page — choose which repositories the app can manage.

   Khi GitHub chuyển hướng trở lại, bạn sẽ thấy xác nhận tài khoản đã được kết nối.

   

   Account connected — return to the Dodo Payments dashboard to continue.

3. Pick a repository and permission

   Quay lại dashboard, chọn repository mà entitlement sẽ cấp quyền truy cập và chọn cấp permission. Bộ chọn repository chỉ hiển thị những repository mà GitHub App có quyền truy cập. Đặt name cho entitlement và nhấp Create Entitlement.

   

   Creating a GitHub entitlement. Pick the repository and the permission you want customers to receive.

4. Save the entitlement

   Lưu và gắn entitlement vào bất kỳ sản phẩm nào. Khách hàng mua sản phẩm đó sẽ nhận được lời mời GitHub khi entitlement được cung cấp.

​

Các cấp quyền

Các quyền repository tiêu chuẩn của GitHub được áp dụng:

Permission	Phù hợp nhất cho
pull	Quyền chỉ đọc. Khách hàng có thể clone, fetch và xem repo.
triage	Quyền đọc cùng khả năng quản lý issue và pull request.
push	Quyền đọc + ghi. Khách hàng có thể push branch và mở pull request.
maintain	Quyền push cùng khả năng quản lý cài đặt repository (không bao gồm các cài đặt nhạy cảm).
admin	Toàn quyền kiểm soát repository. Hãy sử dụng thận trọng.

Cấp least privilege phù hợp với trường hợp sử dụng của bạn. Hầu hết các tình huống cung cấp nội dung trả phí chỉ cần pull.

​

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 cùng một oauth_url để khách hàng liên kết tài khoản GitHub.
3. Khách hàng cấp quyền thông qua liên kết trong email hoặc customer portal.
4. Dodo Payments mời tài khoản GitHub của khách hàng vào repository với permission đã cấu hình. Grant chuyển sang delivered khi lời mời được tạo.
5. Nếu subscription bị hủy, hoàn tiền hoặc thu hồi, khách hàng sẽ bị xóa khỏi danh sách cộng tác viên.

​

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

Field	Bắt buộc	Mô tả
target_id	Có	Repository để mời khách hàng vào. Bộ chọn repository trong dashboard sẽ điền giá trị này cho bạn.
permission	Có	Một trong các giá trị pull, push, triage, maintain, admin.

​

Tạo qua API

TypeScript

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

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

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("pull"),
    },
  ),
})

​

Webhooks

Các webhook events entitlement_grant.* tiêu chuẩn bao quát quy trình GitHub:

• entitlement_grant.created bao gồm oauth_url để cấp quyền GitHub.
• entitlement_grant.delivered được kích hoạt khi lời mời cộng tác viên được tạo.
• entitlement_grant.failed được kích hoạt cùng error_code: "github_permission_denied" (hoặc tương tự) nếu GitHub App mất quyền truy cập vào repository.

​

Khắc phục sự cố

Repository picker is empty

GitHub App của Dodo Payments phải được cài đặt trên tổ chức hoặc người dùng sở hữu repository. Mở Entitlements → Integrations → GitHub và cài đặt lại app, đảm bảo cấp quyền truy cập cho các repository liên quan.

Grant fails with permission_denied

Bản cài đặt GitHub App không còn quyền truy cập vào repository hoặc repository đã được đổi tên/chuyển giao. Cấp lại quyền truy cập cho app và lần regrant tiếp theo sẽ thành công.

Customer hasn't accepted the invite

Khách hàng phải chấp nhận lời mời GitHub từ trang thông báo của họ hoặc bằng cách nhấp vào liên kết trong email. Cho đến khi chấp nhận, họ vẫn ở trạng thái “invited” nhưng không thể clone repo. Grant vẫn ở trạng thái delivered theo góc nhìn của Dodo Payments; lời mời là thứ chúng tôi phát hành.