Verwenden der GitHub Marketplace-API in deiner App

Um deine App in GitHub Marketplace zu verwalten, verwende diese GitHub Marketplace-API-Endpunkte.

Eine GitHub Marketplace-App empfängt Informationen zu Änderungen am Plan eines Benutzers aus dem Marketplace-Kaufereignis-Webhook. Ein Marketplace-Kaufereignis wird ausgelöst, wenn ein Benutzer seinen Zahlungsplan kauft, abbricht oder ändert.

GitHub empfiehlt, deine App mit APIs und Webhooks zu testen, bevor du dein Angebot an GitHub Marketplace übermittelst. So kannst du dafür sorgen, dass bei deinen Kunden keine Probleme auftreten. Bevor eine Onboardingexpertin deine App genehmigt, muss dafür gesorgt sein, dass diese den Abrechnungsflow ordnungsgemäß ausführt.

Wenn ein Kunde einen kostenpflichtigen Plan, eine kostenlose Testversion oder die kostenlose Version deiner GitHub Marketplace-App erwirbt, wird der marketplace_purchase-Ereigniswebhook mit der purchased-Aktion ausgelöst, der den Kaufprozess startet.

Durch das Up- oder Downgrade einer GitHub Marketplace-App wird der marketplace_purchase-Ereigniswebhook mit der changed-Aktion ausgelöst, die den Up- oder Downgradeflow auslöst.

Durch die Kündigung einer GitHub Marketplace-App wird der marketplace_purchase-Ereigniswebhook mit der Aktion cancelled ausgelöst, wodurch der Kündigungsprozess gestartet wird.