Skip to main content

アプリで GitHub Marketplace API を使用する

GitHub Marketplace用に、アプリケーションにGitHub Marketplace APIとwebhookイベントを統合する方法を学んでください。

GitHub Marketplace API の REST エンドポイント

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

GitHub Marketplace API の Webhook イベント

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

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

GitHubでは、リストを GitHub Marketplace に送信する前に、API と Webhook を使用してアプリをテストすることをお勧めします。そのため、お客様に最適なエクスペリエンスを提供できます。 オンボーディングの専門家の検証前に、アプリケーションは支払いフローを適切に処理しなければなりません。

新しい購入や無料トライアルの処理

お客様が有料プラン、無料試用版、または GitHub Marketplace アプリの無料バージョンを購入すると、イベント Webhook が送信され、marketplace_purchase が含まれ、購入プロセスが開始されます。

プラン変更の処理

GitHub Marketplace アプリをアップグレードまたはダウングレードすると、marketplace_purchaseイベント Webhookがchangedアクションと共にトリガーされ、アップグレードまたはダウングレードのフローが開始されます。

プランのキャンセルの処理

GitHub Marketplace アプリをキャンセルすると、marketplace_purchase イベント Webhook が cancelled アクションでトリガーされ、キャンセルの流れが開始されます。