Deep-Links hinzufügen

Erstellen Sie Deep-Links, über die Nutzer/innen zu Ihrer Stripe-App gelangen.

Bei einem Deep Link handelt es sich um eine URL, die die Anzahl der Navigationsschritte zum Öffnen Ihrer App im Dashboard reduziert. Sie können Deep Links in Nutzeroberflächen wie E-Mails oder Websites freigeben und sie beim Erstellen von OAuth-Autorisierungs-Workflows verwenden.

Bevor Sie loslegen

Um eine Dashboard-Seite mit Ihrer App zu erstellen, benötigen Sie eine App mit Nutzeroberflächenfunktion.

Deep-Link-URL erstellen

Zum Erstellen der URL des Deep Link müssen Sie Folgendes verwenden:

Die ID des Stripe-Kontos, auf dem Ihre App installiert ist. Weitere Informationen finden Sie unter Nutzerkontext.
Die URL einer Dashboard-Seite, auf der Sie eine Ansicht definiert haben.
Der Apps-Parameter, um Ihre App anzugeben und festzulegen, wo sie geöffnet werden soll.
Ihr Anmeldeformular, das im ID-Feld Ihrer stripe-app.json-Manifestdatei angegeben ist.

Hinweis

Ein älteres Format mit dem open_drawer_app-Parameter funktioniert weiterhin für die Abwärtskompatibilität, aber das moderne Apps-Parameterformat wird empfohlen.

Deep-Link-Format

Die Struktur einer Deep-Link-URL ist:

https://dashboard.stripe.com/<MODE>/acct_<ACCOUNT_ID>/<PAGE>?apps[<APP_ID>][TARGET]=VIEWPORT_ID

Hier gilt:

MODUS: Test für Test-Modus oder Auslassung für Live-Modus
KONTO_ID: Die ID des Stripe-Kontos (beginnt mit acct_)
SEITE: Die anzuzeigende Dashboard-Seite (z. B. Kundinnen und Kunden, Rechnungen oder Dashboard)
APP_ID: Ihre Anwendungs-ID aus Ihrer Manifestdatei
ZIEL: Wo Sie Ihre App öffnen können, z. B. als Drawer oder Modal
VIEWPORT_ID: In Ihrer Manifestdatei konfigurierte Darstellungsfeld-IDs (z. B. stripe.dashboard.payment.list)

Beispiele

Wenn Sie auf der Kundenseite im Dashboard (https://dashboard.stripe.com/test/customers?) eine Ansicht definieren und Ihr Anwendungs-ID com.example.my-app lautet:

Der Deep Link für den Test-Modus und die Sandbox lautet:

  <a href="https://dashboard.stripe.com/test/acct_id/customers?apps[com.example.my-app][drawer]=">Deep Link</a>

Der Deep Link für den Live-Modus lautet:

<a href="https://dashboard.stripe.com/acct_id/customers?apps[com.example.my-app][drawer]=">Deep Link</a>

Sie können Ihre App auf jeder Dashboard-Seite öffnen, auf der Sie eine Ansicht definiert haben. Um sie beispielsweise auf der Dashboard-Startseite zu öffnen:

 <a href="https://dashboard.stripe.com/test/acct_id/dashboard?apps[com.example.my-app][drawer]=">Deep Link</a>

Um einen Deep-Link zu Ihrem Onboarding-Modal zu erstellen, verwenden Sie Modal anstelle von Drawer:

<a href="https://dashboard.stripe.com/acct_id/dashboard?apps[com.example.my-app][modal]=">Open in Modal</a>

Verwenden Sie unbedingt die URL für den Live-Modus, wenn Sie den Deep Link mit Ihren Nutzer/innen teilen. Sie können den Link überall für Nutzer/innen teilen, die Ihre App installiert haben. Wenn die Nutzer/innen ihre App nicht installiert haben, bevor sie auf den Deep Link klicken, leitet Stripe sie zu einer geschlossenen App, die nicht im Dashboard geöffnet werden kann.

Deep Link testen

Melden Sie sich beim Dashboard als Nutzer/in an, der/die die App installiert hat.
Klicken Sie auf den Deep Link.
Sollten Sie zu einer Anwendung weitergeleitet werden, die sich nicht öffnen lässt, überprüfen Sie bitte Folgendes:
- Der Parameter Apps verwendet die korrekte Anwendungs-ID aus Ihrem Manifest
- Die Konto-ID im URL-Pfad ist korrekt (Format: acct_ gefolgt von alphanumerischen Zeichen)
- Die Nutzerin bzw. der Nutzer hat die App für dieses Konto installiert
- Die Dashboard-Seite in der URL verfügt über eine für Ihre App definierte Ansicht