GitHub Entitlement

Conceda aos clientes acesso de colaborador a um repositório privado do GitHub no nível de permissão que você escolher, e revogue automaticamente em caso de cancelamento.

O GitHub entitlement adiciona um cliente pagante como colaborador em um repositório privado. Você escolhe o nível de permissão (pull, push, triage, maintain, ou admin) e o Dodo Payments gerencia o convite, rastreamento de aceitação e remoção em caso de cancelamento.

​

O que é entregue

• O cliente é convidado ao seu repositório do GitHub por meio de um fluxo OAuth que vincula a conta do GitHub à compra.
• Uma vez aceito, o GitHub concede a eles acesso de colaborador no nível de permissão configurado.
• Cancelamento, reembolso ou revogação manual removem o colaborador.

Usos comuns incluem produtos com código disponível, modelos pagos, repositórios de código de cursos e SDKs exclusivos para clientes.

​

Conectar GitHub

1. Open Entitlements

   No seu painel do Dodo Payments, vá para Entitlements e clique em + para começar um novo entitlement.

2. Pick GitHub

   Escolha Acesso ao GitHub como a integração. Se o GitHub ainda não estiver conectado, você será solicitado a Conectar GitHub.

   

   Connect GitHub prompt before the install handoff.

   Ao clicar, abre o GitHub em uma nova aba. Faça login, então instale o Dodo Payments GitHub App na organização ou conta de usuário que possui o repositório. Você pode conceder acesso a todos os repositórios ou apenas aos que pretende restringir.

   

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

   Quando o GitHub redirecionar de volta, você verá uma confirmação de que a conta está conectada.

   

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

3. Pick a repository and permission

   De volta ao painel, escolha o repositório que o entitlement deve conceder acesso e selecione o nível de permissão. O seletor de repositórios apenas mostra os repositórios que o GitHub App tem acesso. Dê um nome ao entitlement e clique em Criar Entitlement.

   

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

4. Save the entitlement

   Salve e anexe o entitlement a qualquer produto. Clientes que comprarem esse produto recebem um convite do GitHub na entrega.

​

Níveis de permissão

As permissões padrão do repositório GitHub se aplicam:

Permissão	Melhor para
pull	Acesso somente leitura. Os clientes podem clonar, buscar e visualizar o repositório.
triage	Acesso de leitura mais a possibilidade de gerenciar problemas e pull requests.
push	Acesso de leitura + escrita. Os clientes podem enviar branches e abrir pull requests.
maintain	Acesso para enviar mais o gerenciamento de configurações do repositório (exceto as sensíveis).
admin	Controle total do repositório. Use com cautela.

Conceda o mínimo privilégio que atenda ao seu caso de uso. A maioria dos cenários de conteúdo pago só precisa de pull.

​

Fluxo do cliente

1. O cliente conclui o checkout.
2. O Dodo Payments cria uma concessão em status pending com um oauth_url para o cliente vincular sua conta do GitHub.
3. O cliente autoriza através do link no e-mail ou portal do cliente.
4. O Dodo Payments convida a conta do GitHub do cliente para o repositório na permissão configurada. A concessão muda para delivered assim que o convite é criado.
5. Se a assinatura for cancelada, reembolsada ou revogada, o cliente é removido como colaborador.

​

Configuração necessária

Campo	Obrigatório	Descrição
target_id	Sim	O repositório para convidar o cliente. O seletor de repositório do painel preenche isso para você.
permission	Sim	Um dos pull, push, triage, maintain, admin.

​

Criar via 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

Os eventos padrão de webhooks entitlement_grant.* cobrem o fluxo do GitHub:

• entitlement_grant.created inclui o oauth_url para a autorização do GitHub.
• entitlement_grant.delivered dispara uma vez que o convite de colaborador é criado.
• entitlement_grant.failed dispara com error_code: "github_permission_denied" (ou similar) se o GitHub App perder o acesso ao repositório.

​

Solução de problemas

Repository picker is empty

O Dodo Payments GitHub App deve estar instalado na organização ou usuário que possui o repositório. Abra Entitlements → Integrações → GitHub e reinstale o app, garantindo acesso aos repositórios relevantes.

Grant fails with permission_denied

A instalação do GitHub App não tem mais acesso ao repositório, ou o repositório foi renomeado/transferido. Re-conceda acesso ao app e a próxima concessão será bem-sucedida.

Customer hasn't accepted the invite

Os clientes devem aceitar o convite do GitHub na página de notificações ou clicando no link em seu e-mail. Até que aceitem, permanecem “convidados” mas não podem clonar o repositório. A concessão ainda é delivered na perspectiva do Dodo Payments; o convite é o que emitimos.