Ein Plugin zu einer RAK-App migrieren

So migrieren Sie Ihr Plugin über Stripe Apps zur RAK-Authentifizierung.

Verwenden Sie diesen Leitfaden, um Ihr vorhandenes Plugin zu einer Stripe-App zu migrieren, die eingeschränkte API-Schlüssel (RAKs) für die Authentifizierung verwendet, auch bekannt als RAK-App. Weitere Informationen zu RAKs finden Sie unter Passen Sie den API-Zugriff mit eingeschränkten API Schlüsseln an.

Zuvor hat es Stripe Plugins gestattet, die Standard-API-Schlüssel eines Nutzers/einer Nutzerin anzufordern, um sich mit deren Produkten zu vernetzen. Ab dem 30. September 2024 verlangt Stripe von allen Plugin-Entwicklern/Entwicklerinnen, dass sie sichere Authentifizierungsmethoden (eingeschränkte API-Schlüssel, OAuth 2.0 oder Stripe Connect) verwenden, um die Nutzer/innen vor Betrug zu schützen. Alle vorhandenen und neuen Plugin-Entwickler/innen müssen eine dieser sicheren Autorisierungsmethoden verwenden. Die Migration Ihres Plugins auf eine RAK-App erfüllt diese Anforderung.

Bevor Sie loslegen

Lesen Sie den Abschnitt Ein Plugin zu Stripe Apps oder Stripe Connect migrieren.
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.

Stripe-CLI-Plugin installieren

Melden Sie sich beim Stripe-Dashboard an.
Sofern noch nicht geschehen, installieren Sie die Stripe-CLI und melden Sie sich mit demselben Konto an.
Command Line
Homebrew
# Install Homebrew to run this command: https://brew.sh/ brew install stripe/stripe-cli/stripe # Connect the CLI to your dashboard stripe login
Weitere Installationsoptionen finden Sie unter Mit der Stripe-CLI loslegen.
Vergewissern Sie sich, dass es sich um die Version 1.12.4 oder neuer handelt. Dies können Sie folgendermaßen überprüfen:
Command Line
```
stripe version
```
Wenn Ihrer Stripe-CLI-Version älter als 1.12.4 ist, führen Sie eine Aktualisierung auf die neueste Stripe-CLI-Version durch.
Stellen Sie sicher, dass der Knoten installiert und auf dem neuesten Stand ist.
Command Line
```
node -v
```
Sie können die Abhängigkeiten Ihrer App mit NPM oder Yarn verwalten. Verwenden Sie unbedingt die neueste stabile Version. Wenn Sie Ihre App im App Marketplace veröffentlichen möchten gelten zusätzliche Einschränkungen:
- Sie benötigen ein aktiviertes Konto.
- Sie können eine App nicht in einem Connect-fähigen Stripe-Konto veröffentlichen.

Ihre App entwickeln

Installieren Sie das CLI-Plugin für Stripe-Apps: Um mit der Erstellung einer Stripe-App zu beginnen, installieren Sie das CLI-Plugin für Stripe-Apps:
Command Line
```
stripe plugin install apps
```
Wenn Sie das apps-Plugin bereits installiert haben, überprüfen Sie, ob Sie Version 1.5.12 oder höher verwenden.
Command Line
```
stripe apps -v
# apps version 1.5.12
```
Wenn Sie das apps-Plugin aktualisieren müssen, können Sie Folgendes ausführen:
Command Line
```
stripe plugin upgrade apps
```
Erstellen Sie Ihre App mit unserer Vorlage:
Command Line
```
stripe apps create <app-name> --template restricted-api-key-app
```
- Bei der Benennung Ihrer App verbietet Stripe die folgenden Begriffe: Authenticator, RAK, Generator, RAK Auth, App, Generator-App, Stripe.
- Wenn Sie eine App für einen Drittanbieter entwickeln, verwenden Sie die folgende Namenskonvention: [App-Funktionalität] von [Entwicklername]. Zum Beispiel: Hubspot Sync von Boomi, Analytics Pro von DataWiz oder Invoice Manager von PayFlow.
Fügen Sie alle Berechtigungen hinzu, die Ihre App benötigt.
Bearbeiten Sie Ihre App-Einstellungsseite. Wenn Sie die obige Vorlage verwenden, erstellt Stripe automatisch eine Einstellungsansicht. Fügen Sie auf der Einstellungsseite Anweisungen oder Links zu Ihrer eigenen Dokumentation hinzu, auf die Ihre Nutzer/innen bei der Einrichtung Ihrer App zurückgreifen können.
Laden Sie Ihre App hoch. Nachdem Sie Ihre RAK-App hochgeladen haben, können Sie die API-Authentifizierungsmethode nicht mehr ändern.

Ihre App testen

Testen Sie im Dashboard den eingeschränkten API-Schlüssel für Ihr eigenes Konto:

Installieren Sie Ihre App im Testmodus für Ihr Konto.
Zeigen Sie Ihre installierten Apps an und klicken Sie auf Ihre kürzlich installierte App.
Klicken Sie auf der Seite mit den App-Einstellungen auf API-Schlüssel anzeigen. Kopieren Sie diesen Geheimschlüssel, um Ihre Integration zu testen.

Testen Sie Ihre App mit anderen Live-Konten, bevor Sie Ihre App veröffentlichen. Verwenden Sie die externe Testfunktion, um bis zu 25 Nutzer/innen einzuladen, Ihre App in ihren Konten zu testen:

Wählen Sie im Dashboard für Entwickler/innen > Apps die App aus, die Sie extern testen möchten.
Klicken Sie auf der Detailseite der App auf die Registerkarte Externer Test und dann auf Jetzt starten.
- Wenn diese Registerkarte nicht angezeigt wird, überprüfen Sie, ob Sie unter Veröffentlichung erstellen die öffentliche Verteilung ausgewählt haben.
Füllen Sie die folgenden Felder aus, um externe Tests zu konfigurieren (die Sie jederzeit bearbeiten können):
- Link-Zugriff: Wählen Sie aus, ob jeder die App über den Link installieren oder ob nur eingeladene Nutzer/innen zugelassen werden sollen.
- Version: Wählen Sie aus, welche Version die Nutzer/innen installieren können. Wenn Sie die Version ändern, wird für alle aktuellen Nutzer/innen eine Aktualisierung auf die neue Version vorgenommen.
Klicken Sie auf den Einladungslink, um ihn zu kopieren und an Ihre Nutzer/innen zu senden, damit sie die App in ihrem Konto installieren können. Diese Nutzer/innen müssen über Administratorrechte verfügen, um die App installieren zu können. Nachdem ein/e Nutzer/in die Testversion Ihrer App installiert hat, können alle Mitglieder des Kontos diese verwenden.

Weitere Informationen zu externen Tests finden Sie unter App extern testen.

Veröffentlichen und verbreiten Sie Ihre App

So veröffentlichen Sie Ihre App im Stripe App Marketplace:

App zur Prüfung vorlegen.
Nachdem Stripe Ihre App genehmigt hat, veröffentlichen Sie Ihre App im Stripe App Marketplace.

So verteilen Sie Ihre App:

Sehen Sie sich Ihre installierten Apps an und klicken Sie auf die App, die Sie verteilen möchten. Klicken Sie auf der Detailseite der App auf die Registerkarte Einstellungen.
Kopieren Sie den Installationslink für Ihre App. Jede/r Nutzer/in, der/die auf diesen Link klickt, wird zum Installationsablauf für Ihre App weitergeleitet.
Verwenden Sie konsequent denselben Installationslink für Ihr Produkt und in den Nutzermitteilungen. Einige zu berücksichtigende Beispiele sind:
- Aktualisieren Sie Ihre Dokumentation, um Nutzer/innen anzuweisen, die Stripe-RAK-App zu installieren. Ihre Nutzer/innen müssen den eingeschränkten API-Schlüssel kopieren und in Ihre Website- oder Plugin-Konfiguration einfügen.
- Fügen Sie den Installationslink zu Ihrem Plugin-Onboarding hinzu, um Nutzern/Nutzerinnen die Installation der App und das Kopieren des eingeschränkten API-Schlüssels zu erleichtern.
- Verwenden Sie den Installationslink in der E-Mail-Kommunikation mit den Nutzern/Nutzerinnen, um sie bei der Aktualisierung ihrer bestehenden Installationen zu unterstützen.

Ihre bestehenden Nutzer/innen migrieren

Nachdem Sie Ihr Plugin zu einer Stripe-App migriert haben, müssen Sie Ihre bestehenden Nutzer/innen migrieren. Je nachdem, wie Sie normalerweise mit Ihren Nutzern/Nutzerinnen interagieren, kann die Vorgehensweise unterschiedlich sein. Hier sind einige allgemeine Richtlinien, die jedoch für die meisten Plugins gelten:

Benachrichtigen Sie Ihre Nutzer/innen. Informieren Sie Ihre bestehenden Nutzer/innen, dass sie ihre Verbindung zu Stripe über Ihren Installationslink per E-Mail, in der Nutzeroberfläche Ihres Plugins, über produktinterne Benachrichtigungen, in den Versionshinweisen oder über eine andere Kommunikationsmethode aktualisieren sollen.
API-Schlüssel aktualisieren. Nachdem ein/e Nutzer/in Ihre App installiert und seinen/ihren neuen eingeschränkten API-Schlüssel bereitgestellt hat, löschen Sie seinen/ihren vorherigen geheimen API-Schlüssel.
Verfolgen Sie den Fortschritt der Nutzermigration. Verfolgen Sie nach Möglichkeit den Fortschritt der Nutzermigrationen. Setzen Sie sich mit Nutzern/Nutzerinnen in Verbindung, die noch nicht migriert sind, um einen reibungslosen Übergang zu gewährleisten.

OptionalDen Systemzustand Ihrer App überwachen und verbessern

Sie können die folgenden Maßnahmen erkunden und umsetzen, um den Zustand Ihrer App proaktiv zu verbessern:

Um Ihre App zu bewerben, können Sie dem Stripe Partner Ecosystem als Teil des Apps Track beitreten. Alle App-Entwickler/innen sind berechtigt, dem Partnerprogramm beizutreten, und Apps, die bestimmte Meilensteine erreichen, können zusätzliche Partnervorteile freischalten, wenn sie sich weiterentwickeln.
Um das Stripe-Dashboard zu erweitern und nutzerdefinierte Funktionen für Ihre Nutzer/innen bereitzustellen, erstellen Sie eine Erweiterung der Nutzeroberfläche.
Verfolgen Sie Ihre App-Analyse, um Einblicke in die Leistung Ihres Eintrags im App-Marktplatz zu erhalten, einschließlich der Nutzerinstallationskennzahlen.

OptionalZahlungen konfigurieren

Wenn Sie eine App entwickeln, mit der Nutzer/innen Zahlungen abwickeln können, lesen Sie diese Richtlinien:

Zahlungsdaten sicher erfassen

Nutzer/innen von Stripe müssen für PCI-Konformität sorgen, die festlegt, wie Kreditkartendaten sicher zu speichern, zu verarbeiten und zu übertragen sind. Bei Nichteinhaltung oder möglichen Verstößen drohen Unternehmen Strafen.

Da Sie API-Aufrufe für Nutzer/innen von Stripe tätigen, müssen Sie Kreditkartendaten sicher mithilfe der clientseitigen Tokenisierung übermitteln. Kundinnen/Kunden übermitteln ihre persönliche Daten über einen Webbrowser oder eine mobile App direkt an Stripe. Im Gegenzug sendet Stripe ein einfaches Token an Sie. So können Ihre Nutzer/innen Kartendaten sicher erfassen, ohne dass sensible Daten auf den Server gelangen.

Wenn Ihr Plugin ein clientseitiges Zahlungsformular im Browser umfasst, empfehlen wir die Verwendung von:

Stripe Elements: Eine Reihe vorgefertigter Komponenten der Nutzeroberfläche zur Einrichtung Ihres Web-Bezahlvorgangs. Es ist als Feature von Stripe.js verfügbar, unserer grundlegenden JavaScript-Bibliothek für die Erstellung von Zahlungsabläufen.
Stripe Checkout: Eine Low-Code-Zahlungsintegration, die ein anpassbares Formular für den Zahlungseinzug erstellt. Sie können Checkout direkt in Ihre Website integrieren oder Kundinnen/Kunden auf eine von Stripe gehostete Zahlungsseite weiterleiten.

Beide Optionen bieten die clientseitige Tokenisierung.

Wenn Ihr Plugin nur in einer Backend-Umgebung betrieben wird, sollten Sie die Nutzer/innen in Ihrer Dokumentation dazu auffordern, die Zahlungsangaben mit Elements oder Checkout zu tokenisieren. Durch die Tokenisierung können Nutzer/innen von Stripe Zahlungen so sicher wie möglich auf unserer Plattform abwickeln.

Express Checkout Element hinzufügen

Das Express Checkout Element bietet eine einzelne Integration für die Annahme von Zahlungen über Ein-Klick-Zahlungsschaltflächen, einschließlich Apple Pay, Google Pay, Link oder PayPal. Diese Integration ermöglicht es Ihnen, mehrere Schaltflächen gleichzeitig anzuzeigen. Kundinnen/Kunden sehen unterschiedliche Zahlungsschaltflächen, je nachdem, was ihre Geräte- und Browser-Kombination unterstützt.

Mehrere Zahlungsmethoden ermöglichen

Stripe unterstützt neben Kreditkarten noch mehrere andere Zahlungsmethoden. Weitere Informationen zu Zahlungsmethoden finden Sie unter Zahlungsmethoden.

Mit der Payment Methods API können Ihre Nutzer/innen Zahlungen mit weiteren Zahlungsmethoden erfassen (beispielsweise Alipay, iDEAL, Sofort). Sie können diese Zahlungsmethoden über einen Integrationspfad hinzufügen.

Prüfen, ob HTTPS aktiviert ist

Wenn Ihr Plugin ein Zahlungsformular in einem Webbrowser anzeigt, muss es prüfen, ob das Formular über HTTPS bereitgestellt wird. Wir verlangen von unseren Nutzer/innen, dass sie HTTPS aktivieren: Zeigen Sie Ihren Nutzer/innen eine eindeutige Fehlermeldung an, wenn sie nicht ausreichend geschützt sind.

Das folgende Beispiel zeigt, wie Sie überprüfen können, ob Ihre Nutzer/innen HTTPS aktiviert haben:

Command Line
// This example uses Express
const express = require('express');
const app = express();

app.get('/', function(request, response) {
 if (!request.secure) {
   // Present an error to the user
 }
});


app.listen(3000);

Wenn Ihr Plugin eine Frontend-Komponente hat, prüfen Sie, ob HTTPS vom Browser verwendet wird. Mit JavaScript sähe das z. B. so aus:

Command Line
// This example checks for HTTPS from the browser
if (window.location.protocol !== "https:") {
 // Present an error to the user
}