Usando a API do Marketplace GitHub em 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.

GitHub recomenda testar seu aplicativo com APIs e webhooks antes de enviar sua listagem para GitHub Marketplace para que você possa fornecer 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 adquire um plano pago, um período de teste gratuito ou a versão gratuita do seu aplicativo GitHub Marketplace, você receberá o marketplace_purchase evento webhook com a ação purchased, que inicia o fluxo de compra.

Atualizar ou reverter a atualização de um aplicativo do GitHub Marketplace aciona o webhook do evento marketplace_purchase com a ação changed, o que dá início ao fluxo de atualização ou reversão de atualização.

O cancelamento de um aplicativo GitHub Marketplace dispara o webhook do marketplace_purchase evento com a cancelled ação, o que inicia o fluxo de cancelamento.