Aktionen und Einstellungen nach der Installation ermöglichen

Installiert ein/e Nutzer/in Ihre App, können Sie weitere Aktionen oder Konfigurationsschritte verlangen. Ihre App kann beispielsweise verlangen, dass der/die Nutzer/in gesonderte Anmeldedaten für den Zugriff auf externe Dienste bereitstellt. Bei Stripe-Apps werden diese Zusatzschritte als Aktionen nach der Installation bezeichnet. Dabei stehen verschiedene Kategorien zur Auswahl:

• Innerhalb der App mit der SettingsView-Komponente
• Extern über einen Link zu einer externen Website

Legen Sie keine Aktionen nach der Installation fest, zeigt das Dashboard die App nach der Installation an.

Aktion nach der Installation hinzufügen

So fügen Sie eine sogenannte Aktion nach der Installation hinzu:

1. Öffnen Sie Ihre App-Manifest-Datei.

2. Fügen Sie das neue Feld post_install_action hinzu.

   stripe-app.json

   {
     "id": "com.invoicing.[YOUR_APP]",
     "version": "1.2.3",
     "name": "[YOUR APP] Shipment Invoicing",
     "icon": "./[YOUR_APP]_icon_32.png",
     "permissions": [],
     "app_backend": {},
     "ui_extension": {},
     "post_install_action": {}
   }
   

3. Fügen Sie eine Konfigurationsoption für die post_install_action hinzu, die Ihrem Anwendungs-Setup spricht.

4. Laden Sie Ihre App bei Stripe hoch.

5. Erstellen Sie eine neue App-Version.

6. Veröffentlichen Sie Ihre App im Marketplace.

Konfigurationsoptionen

Stripe Apps unterstützt die folgenden Aktionen nach der Installation:

• App-Verlinkung
• Einstellungslink
• Verlinkung einer externen URL

App-Verlinkung (Standardeinstellung)

Standardmäßig werden die Nutzer/innen nach der Installation Ihrer App zur Nutzeroberfläche der Anwendung weitergeleitet (sofern vorhanden).

Dazu sind keine weiteren Einstellungen erforderlich.

Verlinken Sie eine externe URL

Sollen die Nutzer/innen für die App-Konfiguration auf eine externe Seite weitergeleitet werden, ändern Sie in Ihrem App-Manifest den Parameter post_install_action folgendermaßen:

{
  "id": "com.invoicing.[YOUR_APP]",
  "version": "1.2.3",
  "name": "[YOUR APP] Shipment Invoicing",
  "icon": "./[YOUR_APP]_icon_32.png",
  "permissions": [],
  "app_backend": {},
  "ui_extension": {},
  "post_install_action": {
    "type": "external",
    "url": "https://[YOUR-URL]"
  }
}

Ersetzen Sie [YOUR-URL] durch die URL der externen Website.

Nach der Installation wird in der App eine Schaltfläche angezeigt, über die die Nutzer/innen zu der in der Anwendungsmanifestdatei angegebenen URL weitergeleitet werden.

Diese URL enthält den Abfragezeichenfolgenparameter account_id, mit dem Sie den/die Nutzer/in identifizieren können. Zum Beispiel:

https://www.company.com/marketplace/stripe?account_id=12345

Verlinkung auf Einstellungen

Enthält Ihre App eine SettingsView-Komponente, können Sie eine post_install_action einrichten, damit diese nach der Installation geöffnet wird. Dazu ändern Sie Ihre Anwendungsmanifestdatei wie folgt:

{
  "id": "com.invoicing.[YOUR_APP]",
  "version": "1.2.3",
  "name": "[YOUR APP] Shipment Invoicing",
  "icon": "./[YOUR_APP]_icon_32.png",
  "permissions": [],
  "app_backend": {},
  "ui_extension": {},
  "post_install_action": {
    "type": "settings"
  }
}

Wird Ihre Anwendung installiert, wird darin eine Schaltfläche angezeigt, über die die Nutzer/innen zur SettingsView-Komponente Ihrer App gelangen.