Sandbox-Unterstützung für Ihre öffentliche App aktivieren

Eine Sandbox ist eine isolierte Testumgebung. Verwenden Sie Ihre Sandbox, um die Stripe-Funktionalität in Ihrem Konto zu testen und damit zu experimentieren, ohne dass sich dies auf Ihre Live-Integration auswirkt. Nutzer/innen können Apps in Sandboxes installieren, um deren Features und Funktionalität zu bewerten.

Test-Modus im Vergleich zur Sandbox-Unterstützung

Stripe unterstützt drei Umgebungen: Sandboxes, Live-Modus und Test-Modus. Für neue Stripe-Unternehmen sind jedoch Sandboxes die Standard-Testmethode.

Wir empfehlen dringend, Sandbox-Unterstützung für Ihre App zu implementieren, damit so viele Händler/innen wie möglich Ihre App vor der Live-Schaltung bewerten können.

Sandbox-Unterstützung für Ihre App aktivieren

Standardmäßig können Nutzer/innen Ihre öffentliche App nicht ohne zusätzlichen Aufwand in einer Sandbox installieren.

Ähnlich wie im Test-Modus können Sie Sandbox-Installationen aktivieren, indem Sie das App-Manifest aktualisieren. Nachdem Sie die Sandbox-Unterstützung aktiviert haben, übermitteln Sie Ihre App zur Überprüfung. Die Unterstützung von App-Sandboxes wird im Rahmen des App-Überprüfungsverfahrens verifiziert.

Verwaltete Sandbox

Eine verwaltete Sandbox ist eine spezielle Art von Sandbox, die Stripe automatisch in Ihrem Konto erstellt, um Ihre öffentliche Stripe-App zu unterstützen.

• Stripe erstellt automatisch eine verwaltete Sandbox, wenn Sie zum ersten Mal eine öffentliche App hochladen.

• Wenn ein/e Nutzer/in Ihre App in seiner/ihrer Sandbox installiert, wird eine Verbindung zu Ihrer verwalteten Sandbox hergestellt.

• Sie können Ereignisse von Sandbox-Installation von Nutzer/innen innerhalb Ihrer verwalteten Sandbox debuggen und überwachen.

• Änderungen an einer verwalteten Sandbox wirken sich nicht auf Nutzer/innen aus, die Ihre App im Live- oder Test-Modus installieren.

• Sie können eine verwaltete Sandbox nicht löschen.

Verwaltete Sandbox erstellen

Stripe erstellt automatisch eine verwaltete Sandbox für Sie, wenn Sie zum ersten Mal eine öffentliche Stripe-App in Ihr Konto hochladen.

Für öffentliche Apps, die vor dem 3. Februar 2025 hochgeladen wurden, hat Stripe automatisch eine verwaltete Sandbox in Ihrem Konto erstellt.

Sandbox-Installationen für Ihre öffentliche App aktivieren

stripe plugin upgrade apps

1. Aktualisieren Sie das App-Manifest, um Sandbox-Installationen zu unterstützen.

2. (Optional) Erstellen Sie Sandbox-spezifische Ereignis-Hooks in Ihrer verwalteten Sandbox. Aktualisieren Sie die serverseitige Logik, um diese neuen Endpoints zu überwachen.

3. (Optional) Aktualisieren Sie die serverseitige Logik so, dass Ihre verwalteten Sandbox-API-Schlüssel verwendet werden, wenn Stripe-API-Aufrufe für eine Sandbox-Installation durchgeführt werden.

4. Laden Sie eine neue Version Ihrer App in Ihr Hauptkonto hoch (nicht in Ihre verwaltete Sandbox).

5. Erstellen Sie von Ihrem Hauptkonto aus einen externen Testlink für die Sandbox-fähige Version, die Sie soeben hochgeladen haben.

6. Erstellen und öffnen Sie eine neue Sandbox, um Ihre aktualisierte App zu testen.

7. Rufen Sie in einem Browserfenster den externen Testlink auf, den Sie zuvor erstellt haben, um Ihre App zu installieren.

8. Testen Sie, ob Ihre App wie erwartet funktioniert, wenn sie in einer Sandbox installiert ist.

9. Reichen Sie Ihre neue Version zur Überprüfung durch den Marktplatz ein.

App-Manifest aktualisieren

Um die Installation Ihrer App in einer Sandbox zu unterstützen, deklarieren Sie die Sandbox-Unterstützung im App-Manifest mit sandbox_install_compatible.

Der folgende Beispielcode deklariert die Sandbox-Unterstützung:

{
  "id": "com.invoicing.[YOUR_APP]",
  "version": "1.2.3",
  "name": "[YOUR APP] Shipment Invoicing",
  "icon": "./[YOUR_APP]_icon_32.png",
  "distribution_type": "public",
  "sandbox_install_compatible": true
}

Sandbox-Verbindungen verstehen

Wenn ein/e Nutzer/in Ihre öffentliche App in seiner/ihrer Sandbox installiert, wird eine Verbindung zu Ihrer verwalteten Sandbox hergestellt. Dies unterscheidet sich von dem Verhalten, wenn Ihre App im Live-Modus oder Test-Modus installiert ist.

• Wenn ein/e Nutzer/in eine App in einer Sandbox installiert, wird eine Verbindung zu Ihrer verwalteten Sandbox hergestellt.

• Wenn ein/e Nutzer/in eine App im Live-Modus installiert, wird eine Verbindung zu Ihrem Live-Modus und Test-Modus hergestellt.

• Wenn ein/e Nutzer/in eine App im Test-Modus installiert, wird eine Verbindung zu Ihrem Test-Modus hergestellt.

Webhook-Ereignisse

Wenn Ihre App Ereignisse aus den Installationen Ihrer Nutzer/innen überwacht, gibt es zusätzliche Einstellungen für den Umgang mit Apps, die in Sandboxes installiert wurden.

• Erstellen Sie in Ihrer verwalteten Sandbox neue Webhooks für Sandbox-Ereignisse.

• Wenn ein/e Nutzer/in Ihre App in einer Sandbox installiert, sendet Stripe alle zutreffenden Ereignisse nur an Ihre verwalteten Sandbox-Endpoints.

• Aktualisieren Sie Ihre serverseitige Logik, um Sandbox-spezifische Ereignisse zu verarbeiten.

Geheimschlüssel für Signatur

Für Webhooks müssen Sie möglicherweise auch den Signatur-Geheimschlüssel aus der verwalteten Sandbox abrufen.

API-Schlüssel

Ihre verwaltete Sandbox verfügt über einen eigenen Satz von API-Schlüsseln zum Aufrufen von Sandbox-Installationen. Wenn Sie auf Sandbox-spezifische Webhooks oder Ereignisse reagieren, müssen Sie diese verwalteten Sandbox-Schlüssel verwenden.

Sie finden die richtigen API Schlüssel für Sandbox-Installationen in Ihrer verwalteten Sandbox.

OAuth-Sandbox-Links

Sie finden Ihre Live-, Test- und Sandbox-OAuth-URLs auf der Registerkarte Externer Test in Ihren App-Einstellungen.

Wenn Ihre App RAK oder die Plattformauthentifizierung verwendet, sind keine Änderungen erforderlich.

Ihre App in einer Sandbox testen

Nachdem Sie Ihre App aktualisiert haben, um Sandbox-Installationen zu verarbeiten, können Sie Ihre App in Ihrer eigenen Sandbox testen.

1. Erstellen Sie in Ihrem Hauptkonto den Link „Externer Test“ für die Sandbox-fähige Version, die Sie soeben hochgeladen haben.

2. Erstellen Sie eine neue Sandbox, um Ihre aktualisierte App zu testen. Öffnen Sie die neue Sandbox.

3. Rufen Sie in einem neuen Browserfenster den Link „Externer Test“ auf, den Sie zuvor erstellt haben, um Ihre App zu installieren.

4. Testen Sie, ob Ihre in einer Sandbox installierte App erwartungsgemäß funktioniert.

Sandbox-API Schlüssel und Webhook-Verhalten validieren

Sie können Workbench verwenden, um zu validieren, dass Ihre Sandbox-Installation korrekt funktioniert.

• Führen Sie in Ihrer Test-Sandbox einige Beispielaktionen aus.

• Öffnen Sie als Nächstes Workbench in Ihrer verwalteten Sandbox.

Verwenden Sie Workbench, um das Verhalten Ihrer App zu überprüfen, einschließlich der Überprüfung von API-Protokollen und dem Filtern von Ereignissens. Wenn Sie Ihre App korrekt aktualisiert haben, können Sie alle API-Aufrufe und Webhook-Ereignisse für Ihre Beispielaktionen sehen.

Wenn die erwarteten Ereignisse oder Antworten nicht angezeigt werden, überprüfen Sie, ob Sie sich in Ihrer verwalteten Sandbox befinden. Überprüfen Sie außerdem, ob Sie Ihre Sandbox-spezifischen Webhook-Endpoints eingerichtet haben und ob Ihre App die korrekten Sandbox-API-Schlüssel verwendet.

App zur Überprüfung einreichen

Nachdem Sie die Sandbox-Unterstützung aktiviert und überprüft haben, ob Ihre App in einer Sandbox wie erwartet funktioniert, können Sie Ihre App zur Überprüfung übermitteln. Die Unterstützung der App-Sandbox wird im Rahmen der App-Überprüfung verifiziert und auf der Detailseite Ihres App-Eintrags aufgeführt.