GitHub Entitlement

​

O que é entregue

• O cliente conecta sua conta do GitHub pelo Customer Portal. Isso vincula a conta do GitHub à compra.
• Dodo Payments convida essa conta para o seu repositório no nível de permissão configurado. O cliente obtém acesso depois de aceitar o convite no GitHub. Se o cliente for o proprietário do repositório, nenhum convite será necessário.
• O cancelamento, o reembolso ou uma revogação manual remove o colaborador e cancela qualquer convite pendente.

​

Conectar GitHub

1

Open Entitlements

No dashboard do Dodo Payments, acesse Entitlements e clique em + para iniciar um novo entitlement.

2

Pick GitHub

Escolha GitHub Access como integração. Se o GitHub ainda não estiver conectado, clique em Connect GitHub.

O GitHub abre em uma nova aba. Faça login e instale o Dodo Payments GitHub App na organização ou conta de usuário que possui o repositório. Você pode conceder ao app acesso a All repositories ou Only select repositories. Se selecionar repositórios, inclua todos os repositórios que pretende restringir.

Quando o GitHub redirecionar de volta, uma página de confirmação mostrará que a conta está conectada.

3

Pick a Repository and Permission

De volta ao dashboard, selecione o Repository ao qual o entitlement concede acesso e, em seguida, selecione o nível de Permission. O seletor de repositórios lista apenas os repositórios aos quais o GitHub App pode acessar. Insira um Name para o entitlement e clique em Create Entitlement.

4

Attach It to a Product

Associe o entitlement a qualquer produto. Os clientes que comprarem esse produto receberão um convite do GitHub depois de conectarem sua conta do GitHub.

​

Níveis de permissão

​

Fluxo do cliente

1. O cliente conclui o checkout.
2. Dodo Payments cria um grant com o status Pending. Dodo Payments tenta criar imediatamente uma URL de autorização do GitHub e a armazena em oauth_url. Se isso falhar, oauth_url permanece como null até que o cliente inicie o fluxo de aceitação.
3. O e-mail de confirmação do pagamento lista o entitlement como Ação necessária e inclui um link para o Customer Portal. No portal, o cliente clica em Conectar e autoriza com o GitHub. Um link de autorização expira após 30 minutos, e o Customer Portal gera um novo quando o cliente retorna.
4. Dodo Payments convida a conta do GitHub do cliente para o repositório com a permissão configurada. O grant muda para Delivered assim que o convite é criado. Se o GitHub rejeitar o convite, o grant não será entregue.
5. Se a assinatura for cancelada, o pagamento for reembolsado ou o grant for revogado, Dodo Payments remove o cliente como colaborador e cancela qualquer convite pendente.

​

Configuração obrigatória

​

Criar via 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 é acionado com status: "Pending". oauth_url pode já conter a URL de autorização do GitHub. Se for null, ele será preenchido quando o cliente iniciar o fluxo de aceitação pelo Customer Portal.
• entitlement_grant.delivered é acionado assim que o convite do colaborador é criado.
• entitlement_grant.revoked é acionado quando o acesso é retirado. Se você desinstalar o GitHub App, Dodo Payments revoga os grants pendentes e entregues dessa instalação com revocation_reason: platform_external.
• entitlement_grant.failed é acionado com error_code: "GRANT_ACCESS_FAILED" se Dodo Payments não conseguir adicionar o cliente ao repositório, por exemplo, porque o GitHub App perdeu o acesso a ele.

​

Solução de problemas