Usar a API do GitHub Marketplace no seu aplicativo

Para ajudar a gerenciar seu aplicativo em GitHub Marketplace, use esses pontos de extremidade da API de GitHub Marketplace.

Um aplicativo do GitHub Marketplace recebe informações sobre mudanças no plano de um usuário no webhook do evento de compra no Marketplace. Um evento de compra no Marketplace é acionado quando um usuário compra, cancela ou muda seu plano de pagamento.

O GitHub recomenda testar seu aplicativo com APIs e webhooks antes de enviar sua listagem para o GitHub Marketplace, para que você possa oferecer uma experiência ideal para os clientes. Antes que um especialista em integração aprove seu aplicativo, ele deverá tratar adequadamente os fluxos de cobrança.

Quando um cliente compra um plano pago, uma avaliação gratuita ou a versão gratuita do seu aplicativo GitHub Marketplace, você recebe o webhook do evento de marketplace_purchase com a ação purchased, que inicia o fluxo de compras.

O upgrade ou o downgrade de um aplicativo do GitHub Marketplace dispara o webhook do evento marketplace_purchase com a ação changed, o que inicia o fluxo de upgrade ou downgrade.

Cancelling a GitHub Marketplace app triggers the marketplace_purchase event webhook with the cancelled action, which kicks off the cancellation flow.