GitHub Entitlement

​

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.

​

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.

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.

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

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.

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

​

Fluxo do cliente

1. O cliente conclui o checkout.
2. Dodo Payments cria um grant com status Pending. Seu oauth_url é null até que o cliente inicie o fluxo de aceitação, momento em que ele é preenchido com uma URL de autorização do GitHub.
3. O cliente autoriza por meio do link no e-mail ou no Customer Portal.
4. Dodo Payments convida a conta do GitHub do cliente para o repositório com a permissão configurada. O grant passa para Delivered assim que o convite é criado.
5. Se a subscription for cancelada, reembolsada ou revogada, o cliente será removido como colaborador.

​

Configuração necessária

​

Criar via API

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

• entitlement_grant.created é disparado com status: "Pending" e oauth_url ainda como null; a URL de autorização do GitHub é preenchida assim que o cliente inicia o fluxo de aceitação pelo e-mail de entrega ou pelo Customer Portal.
• entitlement_grant.delivered é disparado assim que o convite ao colaborador é criado.
• entitlement_grant.failed é disparado com error_code: "github_permission_denied" (ou similar) se o GitHub App perder o acesso ao repositório.

​

Solução de problemas