Skip to main content

Verwenden der GitHub Marketplace-API in deiner App

Hier erfährst du, wie du die GitHub Marketplace-API und Webhook-Ereignisse mit deiner App für den GitHub Marketplace integrierst.

REST-Endpunkte für die GitHub Marketplace-API

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

Webhook-Ereignisse für die GitHub Marketplace-API

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.

Testen der App

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.

Behandeln neuer Käufe und kostenloser Testperioden

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.

Behandeln von Planänderungen

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.

Behandeln von Plankündigungen

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.