Droit GitHub

​

Ce qui est fourni

• Le client connecte son compte GitHub depuis le Customer Portal. Cela associe son compte GitHub à l’achat.
• Dodo Payments invite ce compte à rejoindre votre dépôt avec le niveau d’autorisation configuré. Le client obtient l’accès après avoir accepté l’invitation sur GitHub. Si le client est propriétaire du dépôt, aucune invitation n’est nécessaire.
• Une annulation, un remboursement ou une révocation manuelle supprime le collaborateur et annule toute invitation en attente.

​

Connecter GitHub

1

Open Entitlements

Dans le tableau de bord Dodo Payments, accédez à Entitlements et cliquez sur + pour commencer un nouvel entitlement.

2

Pick GitHub

Choisissez GitHub Access comme intégration. Si GitHub n’est pas encore connecté, cliquez sur Connect GitHub.

GitHub s’ouvre dans un nouvel onglet. Connectez-vous, puis installez la GitHub App de Dodo Payments sur l’organisation ou le compte utilisateur propriétaire du dépôt. Vous pouvez accorder à l’application l’accès à All repositories ou à Only select repositories. Si vous sélectionnez des dépôts, incluez chaque dépôt auquel vous souhaitez restreindre l’accès.

Lorsque GitHub redirige l’utilisateur, une page de confirmation indique que le compte est connecté.

3

Pick a Repository and Permission

De retour dans le tableau de bord, sélectionnez le Repository auquel l’entitlement accorde l’accès, puis sélectionnez le niveau de Permission. Le sélecteur de dépôts répertorie uniquement ceux auxquels la GitHub App peut accéder. Saisissez un Name pour l’entitlement, puis cliquez sur Create Entitlement.

4

Attach It to a Product

Associez l’entitlement à n’importe quel produit. Les clients qui achètent ce produit reçoivent une invitation GitHub après avoir connecté leur compte GitHub.

​

Niveaux d’autorisation

​

Parcours client

1. Le client termine le paiement.
2. Dodo Payments crée une attribution à l’état Pending. Dodo Payments essaie immédiatement de créer une URL d’autorisation GitHub et la stocke dans oauth_url. En cas d’échec, oauth_url reste null jusqu’à ce que le client commence le processus d’acceptation.
3. L’e-mail de confirmation du paiement indique que le droit d’accès nécessite une Action requise et contient un lien vers le Customer Portal. Dans le portail, le client clique sur Connect et autorise l’accès avec GitHub. Un lien d’autorisation expire après 30 minutes, et le Customer Portal en génère un nouveau lorsque le client revient.
4. Dodo Payments invite le compte GitHub du client à rejoindre le dépôt avec le niveau d’autorisation configuré. L’attribution passe à l’état Delivered une fois l’invitation créée. Si GitHub refuse l’invitation, l’attribution n’est pas accordée.
5. Si l’abonnement est résilié, si le paiement est remboursé ou si l’attribution est révoquée, Dodo Payments supprime le client en tant que collaborateur et annule toute invitation en attente.

​

Configuration requise

​

Créer via l’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 est déclenché avec status: "Pending". oauth_url peut déjà contenir l’URL d’autorisation GitHub. S’il contient null, il est renseigné lorsque le client commence le processus d’acceptation depuis le Customer Portal.
• entitlement_grant.delivered est déclenché une fois l’invitation du collaborateur créée.
• entitlement_grant.revoked est déclenché lorsque l’accès est retiré. Si vous désinstallez la GitHub App, Dodo Payments révoque les attributions en attente et accordées de cette installation avec revocation_reason: platform_external.
• entitlement_grant.failed est déclenché avec error_code: "GRANT_ACCESS_FAILED" si Dodo Payments ne peut pas ajouter le client au dépôt, par exemple parce que la GitHub App n’y a plus accès.

​

Dépannage