Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.

Using the GitHub Marketplace API in your app

Learn how to integrate the GitHub Marketplace API and webhook events into your app for the GitHub Marketplace .

  • GItHub Marketplace API用のRESTエンドポイント

    GitHub Marketplace上でのアプリケーションの管理を支援するために、以下のGitHub Marketplace APIエンドポイントを使ってください。

  • GitHub Marketplace APIのためのwebhookイベント

    GitHub Marketplaceアプリケーションは、ユーザのプランに対する変更に関する情報を、Marketplaceの購入イベントwebhookから受け取ります。 Marketplaceの購入イベントは、ユーザが支払いプランの購入、キャンセル、変更をした場合にトリガーされます。

  • アプリケーションのテスト

    リストをGitHub Marketplaceにサブミットする前に、APIとwebhookを使ってアプリケーションをテストし、顧客に理想的な体験を提供できるようにすることをGitHubはおすすめします。 オンボーディングの専門家の検証前に、アプリケーションは支払いフローを適切に処理しなければなりません。

  • Handling new purchases and free trials

    When a customer purchases a paid plan, free trial, or the free version of your GitHub Marketplace app, you'll receive the marketplace_purchase event webhook with the purchased action, which kicks off the purchasing flow.

  • Handling plan changes

    Upgrading or downgrading a GitHub Marketplace app triggers the marketplace_purchase event webhook with the changed action, which kicks off the upgrade or downgrade flow.

  • Handling plan cancellations

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