Mit Stripe Apps ein Plugin migrieren oder erstellen
Zuvor erlaubte Stripe Plugins von Drittanbietern, die Standard-API-Schlüssel eines Nutzers/einer Nutzerin anzufordern, um sie in ihre Produkte zu integrieren. Seit Januar 2024 benötigt Stripe Plugins, um Stripe-Apps zu nutzen. Alle neuen und bestehenden Plugins müssen eine Stripe-App verwenden, um Nutzer/innen für ihren Dienst mit Oauth 2.0 oder einem eingeschränkten API-Schlüssel zu authentifizieren.
Wenn Sie bereits über ein Plugin verfügen, migrieren Sie zu Sicherheits- und Compliance-Zwecken auf den Standard-Integrationspfad von Stripe Apps. Um ein vorhandenes Plugin zu einer Stripe zu migrieren, müssen Sie nur die Authentifizierungsmethode Ihres Plugins ändern.
Notiz
Gründe für eine Migration
Die Authentifizierung über eine Stripe-App ist der neue Standard-Integrationspfad für alle neuen Plugins, Erweiterungen und Partner-Connectors. Der neue Integrationspfad bietet folgende Vorteile:
- Effizienteres Onboarding: Ihre Nutzer/innen müssen API-Schlüssel nicht manuell erstellen.
- Verbesserte Sicherheit: Eingeschränkte API-Schlüssel schützen Nutzer/innen, wenn ihre Schlüssel offengelegt werden.
- Analytik: Verschaffen Sie sich einen Überblick über die Annahmerate und Leistung Ihrer App.
- Erkennbarkeit: Mit Stripe Apps können Sie Ihr Produkt im Stripe-Dashboard, im Stripe App Marketplace und über unser Partnerprogramm umfassend präsentieren.
- Verifizierter Partner: Nehmen Sie an der Apps-Verfolgung im Stripe Partner Ecosystem bei, um von Vorteilen in den Bereichen Co-Selling, Marketing und Technik zu profitieren.
Was passiert, wenn Sie nicht migrieren
Wenn Sie Ihre Authentifizierung nicht zu einer Stripe-App migrieren, funktioniert sie bis 2024 ohne Auswirkungen auf die Benutzererfahrung. Wir werden Plugins in unserem Backend bis Ende 2024 weiterhin unterstützen.
Auswirkungen auf Ihre Nutzer/innen nach der Migration
Wenn Sie sich für eine Migration entscheiden, müssen Ihre Nutzer/innen erneut ein Onboarding und eine Authentifizierung für ihr Plugin durchführen. Um ein Plugin zu migrieren oder zu erstellen, wählen Sie entweder OAuth 2.0 (empfohlen) oder Restricted API Key (RAK)-Authentifizierung. OAuth ist die einfachste Möglichkeit für Nutzer/innen, ein Plugin sicher zu authentifizieren. RAK erfordert kein zusätzliches Backend-Setup von Ihnen. Nutzer/innen müssen jedoch weiterhin generierte Stripe API-Schlüssel in Ihr Drittanbieter-Plugin kopieren und einfügen. Diese Methode erhöht die Komplexität des Authentifizierungsprozesses für Ihre Nutzer/innen.
Bevor Sie loslegen
- Lesen Sie den Abschnitt Bevor Sie beginnen unter Erste Schritte mit Stripe Apps. Stellen Sie sicher, dass Sie die neueste Version der Stripe-CLI installiert haben.
- Wählen Sie Ihren Authentifizierungstyp (OAuth oder RAK). Nachdem Sie Ihre App hochgeladen haben, können Sie die Authentifizierungsmethode nicht mehr ändern. Weitere Informationen zur Authentifizierung finden Sie unter API-Authentifizierung.
- Wenn Sie Stripe Connect verwenden und ein vorhandenes Plugin über Stripe Apps migrieren möchten, müssen Sie ein neues Stripe-Konto erstellen. Derzeit kann ein Stripe-Konto mit aktiviertem Connect keine App veröffentlichen.
- Sie können pro Konto nur eine öffentliche App erstellen. Wenn Ihr Konto bereits über eine öffentliche App verfügt und Sie eine weitere veröffentlichen möchten, müssen Sie ein neues Stripe-Konto erstellen. Sie können weiterhin mehrere private Apps gleichzeitig mit der öffentlichen App auf demselben Konto erstellen.
Wählen Sie eine Authentifizierungsmethode aus, um Ihr Plugin zu migrieren oder zu erstellen:
Entwickeln Sie Ihre App
Erstellen Sie Ihre Stripe-App, indem Sie
stripe apps create <app-name>
in der CLI ausführen.Bearbeiten Sie die folgenden Felder im App-Manifest:
- Setzen Sie
stripe_api_access_type
aufoauth
. - Setzen Sie
distribution_type
aufpublic
. - Legen Sie Ihre
allowed_redirect_uris
fest. Dies sind die URLs, an die Nutzer/innen mithilfe von OAuth nach der Installation Ihrer App weitergeleitet werden. Die erste in der Liste wird als Standardumleitung verwendet.
Ihr App-Manifest sollte folgendermaßen aussehen:
stripe-app.json{ "id": "com.example.my-app", "version": "0.0.1", "name": "Your Stripe App", "icon": "./[YOUR_APP]_icon_32.png", "permissions": [ // Your app permissions here ], "stripe_api_access_type": "oauth", "distribution_type": "public", "allowed_redirect_uris": [ // Your redirect URIs here ] }
- Setzen Sie
Fügen Sie alle Berechtigungen hinzu, die für Ihre App erforderlich sind.
(Optional) Fügen Sie Erweiterungen der Nutzeroberfläche zu Ihrer App hinzu. Wir empfehlen, eine Einstellungsansicht hinzuzufügen, damit Ihre Nutzer/innen Einstellungen konfigurieren oder einen Link zur Dokumentation Ihrer App erstellen können.
Laden Sie Ihre App bei Stripe hoch.
Command Linestripe apps upload
Ihre App testen
- Navigieren Sie zur Detailseite Ihrer App.
- Öffnen Sie die Registerkarte Externer Test und klicken Sie auf Jetzt starten, um einen externen Test einzurichten.
- Greifen Sie auf die Autorisierungslinks im Abschnitt OAuth testen zu. Sie können diesen Link verwenden, um mit Ihrem eigenen Konto zu testen.
OAuth 2.0 konfigurieren
Stellen Sie sicher, dass Sie OAuth 2.0 korrekt konfiguriert haben. Informationen zum Speichern und Aktualisieren von Zugriffstoken finden Sie unter OAuth-Einrichtung.
Veröffentlichen und verbreiten Sie Ihre App
Wenn Sie bereit sind, Ihre App den Nutzer/innen zur Verfügung zu stellen.
- App zur Prüfung vorlegen.
- Nachdem sie genehmigt wurde, veröffentlichen Sie Ihre App im Stripe App Marketplace.
- Klicken Sie auf der Detailseite der App auf die Registerkarte Einstellungen.
- Kopieren Sie den Installationslink. Nutzer/innen können diesen Link verwenden, um Ihre App zu installieren.