App im Stripe App Marketplace veröffentlichen
Machen Sie Ihre App für jede/n Nutzer/in auffindbar, indem Sie sie auf dem Stripe App Marketplace veröffentlichen.
Um Ihre App über Ihr eigenes Team hinaus zu teilen, veröffentlichen Sie sie im Stripe App Marketplace. Dadurch wird die sie für Installation in jedem Stripe-Konto verfügbar, nicht nur in ihrem eigenen.
Für Veröffentlichungen gelten einige Einschränkungen:
- Ihr Konto muss aktiviert werden.
- Sie können nur eine App pro Konto veröffentlichen.
- Um derzeit eine App auf dem Stripe Marketplace zu veröffentlichen, dürfen Sie kein Plattformkonto sein.
- Stripe kann derzeit nur Einträge auf Englisch unterstützen. Wenden Sie sich an Stripe, um weitere Sprachen zu unterstützen.
- Veröffentlichte Apps müssen eine Überprüfung durchlaufen. Weitere Informationen finden Sie unter App-Prüfanforderungen und Richtlinien zur App-Auflistung.
- Wenn Sie Ihre App später aus dem Stripe App Marketplace entfernen möchten, müssen Sie sich mit Stripe in Verbindung setzen.
Diese Einschränkungen gelten nur für Apps, die Sie mit öffentlichen Nutzer/innen im Stripe App Marketplace teilen. Wenn Ihre App nur Ihrem eigenen Team zur Verfügung stehen soll, müssen Sie stattdessen nur wissen, wie Sie Ihre App hochladen und installieren.
Bevor Sie beginnen
- Wenn Sie Ihre App bereits im Live-Modus installiert haben, müssen Sie sie deinstallieren, um zur Veröffentlichung Ihrer App zu wechseln.
- Wählen Sie ein Stripe-Konto aus, das Sie mit Ihrer App verknüpfen möchten. Sie können pro Konto nur eine App veröffentlichen.
- Wie der Genehmigungsablauf Ihrer App für die App-Auflistung aussieht, können Sie in den App-Prüfanforderungen nachlesen.
Verteilungstyp aktualisieren
- Legen Sie den Verteilungstyp Ihrer App auf öffentlich fest.
stripe apps set distribution public
Dieser Befehl aktualisiert die Manifest-Datei, wobei das Feld distribution_
auf den Wert public
festgelegt ist.
{ "id": "com.example.app", "version": "1.2.3", "name": "Example App", "icon": "./example_icon_32.png", "distribution_type": "public" }
Berechtigungen hinzufügen
So fügen Sie die erforderlichen Berechtigungen Ihrer App hinzu:
- Wenn Sie eine Erweiterung zu einer App migrieren, müssen Sie bestimmen, welche Objekte Ihre Erweiterung (nicht Ihre App) in der Stripe-API aufruft, um zu verstehen, welche Berechtigungen aufgenommen werden müssen.
- Liste der Berechtigungen anzeigen, die Sie zu Ihrem App-Manifest hinzufügen können.
- Sie können dem Array
permissions
in Ihrer App-Manifestdateistripe-app.
mit dem folgenden Befehl eine Berechtigung hinzufügen:json
stripe apps grant permission "PERMISSION_NAME" "EXPLANATION"
Geben Sie die Details zu Ihren Berechtigungen in die Eingabeaufforderung ein:
PERMISSION_
: Der Name der Berechtigung, die Sie hinzufügen möchten. Siehe mögliche Berechtigungen.NAME EXPLANATION
: Erklärung für die Aktivierung des Zugriffs. Nutzer/innen sehen diese Erklärung, wenn sie Ihre App installieren.
Wiederholen Sie diesen Schritt für jede neue Berechtigung, die Sie zu Ihrer App hinzufügen möchten.
Ihre App-Manifestdatei sollte folgendermaßen aussehen:
Um eine Berechtigung zu entfernen, können Sie auch die CLI verwenden:
stripe apps revoke permission "PERMISSION_NAME"
Im Test-Modus hochladen
Um Ihre App hochzuladen, führen Sie den folgenden Befehl im Stammverzeichnis Ihres Projekts aus:
stripe apps upload
Stripe validiert Ihr App-Manifest, lädt dann Ihre App hoch und installiert sie in Ihrem Stripe-Testkonto.
Nach diesem Schritt:
- Jedes Teammitglied kann im Test-Modus unter https://dashboard.stripe.com/test/ auf Ihre App zugreifen.
- Ihre App kann im Testmodus Geheimschlüssel speichern.
- Sie können auf den Geheimschlüssel für die Signatur Ihrer App zugreifen, um sie mit einem Backend zu verbinden.
App zur Überprüfung senden
Laden Sie nach dem Festlegen des Verteilungstyps eine neue Version Ihrer App hoch.
Nachdem Sie die gewünschte Verteilungsoption ausgewählt haben, wendet Stripe diese automatisch auf alle zukünftigen App-Versionen an. Um Ihre Verteilungsoption nach Veröffentlichen der App für alle Stripe-Nutzer/innen zu ändern, kontaktieren Sie den Stripe-Support.
Gehen Sie im Stripe-Dashboard zu Apps und wählen dann Ihre App aus, um die Detailseite anzuzeigen.
Wenn Ihre App über mehrere Versionen verfügt, wählen Sie die App-Version aus, die Sie veröffentlichen möchten, und klicken Sie auf Weiter. Wenn Sie keine Version auswählen können, müssen Sie zuerst Ihr Konto aktivieren.
Erstellen Sie Ihren App-Eintrag, indem Sie auf Eintrag bearbeiten klicken. Geben Sie eine Übersicht, Funktionen, Preise und Support sowie Ressourcenlinks an, um Nutzer/innen bei der Bewertung Ihrer App zu unterstützen. Wenn Sie den Eintrag vervollständigen, können Sie eine Vorschau auf der rechten Seite des Dashboard sehen.
Tipps zur Genehmigung von Apps und zur Erstellung eines überzeugenden Eintrags finden Sie in den Richtlinien zur Aufnahme von Apps in das Verzeichnis.
Klicken Sie auf Weiter, um vor der endgültigen Übermittlung der App die folgenden Angaben einzugeben:
- Version: Wenn Ihre App mehrere Versionen hat, wählen Sie die Version aus, die Sie zur Überprüfung vorlegen möchten, und überprüfen Sie sie.
- Marketplace-Installations-URL: Diese Option ist für OAUTH-Apps erforderlich und optional für Apps verfügbar, die Installationslinks unterstützen. Von Stripe App-Marktplatz werden Nutzer/innen zu dieser URL weitergeleitet, um Ihre App zu installieren.
Notiz
Die URL muss auf eine Seite verweisen, die den Onboarding- und Installationsprozess mit klaren Anweisungen initiieren kann.
- Testen von Anmeldedaten: Wenn Ihre App eine Anmeldung erfordert, geben Sie mindestens ein Testkonto an, damit Stripe Ihre App testen und überprüfen kann. Siehe die Beispiele für das Testen von Anmeldedaten.
Vorsicht
Stripe erlaubt Ihnen nicht, echte (Nicht-Test-) Konten für den App-Überprüfungsprozess zu verwenden.
- Anleitung zum Testen: Stellen Sie Nutzerszenarien zur Verfügung, damit Stripe die beabsichtigte Installation und Nutzung Ihrer App durch die Nutzer/innen simulieren kann. Um Ihre Chancen zum Bestehen der App-Überprüfung zu erhöhen, sehen Sie sich die Beispiel-Testanleitung an.
- E-Mails der Kontaktperson: Geben Sie die E-Mail-Adresse der Empfängerin/des Empfängers für Aktualisierungen der App-Überprüfung und die E-Mail-Adresse einer Kontaktperson für die Behebung von Sicherheitsproblemen an.
Alle Änderungen, die Sie nach dem Beginn des Überprüfungsvorgangs vornehmen, unterliegen einem zusätzlichen Überprüfungszeitraum. Um Verzögerungen zu vermeiden, müssen Sie vor der endgültigen Einreichung sicherstellen, dass alle Informationen gemäß den App-Prüfanforderungen korrekt sind.
Um den Überprüfungsvorgang zu starten, klicken Sie auf Zur Überprüfung absenden.
Nachdem Stripe Ihre App geprüft und genehmigt hat, können Sie sie auf dem Stripe App Marketplace veröffentlichen. Wenn Sie Änderungen vornehmen müssen, können Sie die Überprüfung Ihrer App abbrechen. Stripe entfernt dann Ihre Position in der Überprüfungswarteschlange.
Um Verzögerungen zu vermeiden, vergewissern Sie sich vor der endgültigen Übermittlung, dass alle Informationen gemäß den App-Überprüfungsanforderungen korrekt sind. Wenn Ihre App den Status
In Review
aufweist, können Sie Ihre Einreichung nicht mehr zurückziehen und keine Änderungen mehr vornehmen. Nachdem Stripe Ihre App geprüft und genehmigt hat, können Sie sie im Stripe App Marketplace veröffentlichen.
Ihre App veröffentlichen
Nachdem Stripe überprüft hat, ob Ihre App alle App-Überprüfungsanforderungen erfüllt, senden wir eine Benachrichtigung an die Kontakt-E-Mail-Adresse und aktualisieren Ihre App-Detailseite mit einer Überprüfungsentscheidung. Wenn an Ihrer App weitere Änderungen erforderlich sind, erhalten Sie von Stripe eine Anleitung zu den Änderungen, die Sie zur Genehmigung vornehmen müssen. Nachdem Sie die Änderungen implementiert haben, können Sie Ihre App erneut zur Überprüfung einreichen.
Nachdem Stripe Ihre App genehmigt hat, gehen Sie zur Apps-Seite im Dashboard und wählen Ihre App aus. Dort können Sie sich Ihren Eintrag in der Vorschau ansehen, indem Sie auf Überprüfen und veröffentlichen klicken.
Wenn Sie Änderungen vornehmen möchten, klicken Sie auf Abbrechen und bearbeiten. Sie müssen die App dann erneut zur Prüfung einreichen.
Um Ihre App im Stripe App Marketplace zu veröffentlichen und zu listen, klicken Sie auf Veröffentlichen.
Nach diesem Schritt:
- Jede/r Nutzer/in kann Ihre App auf dem Stripe App Marketplace entdecken.
- Jede/r Nutzer/in eines Stripe-Kontos kann Ihre App installieren und nutzen.
- Sie können App-Analysen bereits 24 Stunden nach der Veröffentlichung einsehen.