跳至主要内容

在你的应用中使用 GitHub Marketplace API

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

GitHub Marketplace API 的 REST 端点

为了帮助你管理 GitHub Marketplace 上的应用,请使用这些 GitHub Marketplace API 端点。

GitHub Marketplace API 的 Webhook 事件

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

测试你的应用

GitHub 建议在提交应用到 GitHub Marketplace 列表之前使用 API 和 Webhooks 测试你的应用,以便你可以为客户提供理想的体验。在入职专家批准你的应用之前,它必须能够充分处理计费流程。

处理新购买和免费试用

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

处理计划更改

升级或降级 GitHub Marketplace 应用会触发带有 `changed` 操作的 marketplace_purchase 事件 Webhook,这将启动升级或降级流程。

处理计划取消

取消 GitHub Marketplace 应用会触发带有 `cancelled` 操作的 marketplace_purchase 事件 Webhook,这将启动取消流程。