アプリケーション内での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 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.

プラン変更の処理

GitHub Marketplace アプリケーションのアップグレードあるいはダウングレードによって、marketplace_purchase イベント webhookがchangedアクション付きでトリガされ、それによってアップグレードあるいはダウングレードのフローが開始されます。

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

GitHub Marketplaceアプリケーションをキャンセルすると、marketplace_purchaseイベント webhookがcancelledアクション付きでトリガされます。これによって、キャンセルのフローが開始されます。