跳至主要内容

在应用中使用 GitHub Marketplace API

了解如何将 GitHub Marketplace API 和 webhook 事件集成到您的 GitHub Marketplace 应用中。

GitHub Marketplace API 的 REST 端点

使用这些 GitHub Marketplace API 端点来帮助管理您在 GitHub Marketplace 上的应用。

GitHub Marketplace API 的 webhook 事件

GitHub Marketplace 应用会从 Marketplace 购买事件 webhook 中接收有关用户计划更改的信息。当用户购买、取消或更改其付费计划时,会触发 Marketplace 购买事件。

测试您的应用

GitHub 建议您在将应用提交到 GitHub Marketplace 之前使用 API 和 webhook 测试您的应用,以便为客户提供理想的体验。在入职专家批准您的应用之前,它必须能够充分处理账单流程。

处理新购买和免费试用

当客户购买您的 GitHub Marketplace 应用的付费计划、免费试用或免费版本时,您将收到 marketplace_purchase 事件 webhook,其中包含 purchased 操作,这将启动购买流程。

处理计划变更

升级或降级 GitHub Marketplace 应用会触发 marketplace_purchase 事件 webhook,其中包含 changed 操作,这将启动升级或降级流程。

处理计划取消

取消 GitHub Marketplace 应用会触发 marketplace_purchase 事件 webhook,其中包含 cancelled 操作,这将启动取消流程。