Ajouter des liens profonds

Créez des liens profonds qui redirigent vos utilisateurs vers votre application Stripe.

Un lien profond est une URL qui réduit le nombre d’étapes nécessaires à votre utilisateur pour ouvrir votre application dans le Dashboard. Vous pouvez partager des liens profonds dans les interfaces utilisateur telles que les e-mails, les sites web, etc., ou les utiliser lors de la création des workflows d’autorisation OAuth.

Avant de commencer

Pour rediriger les utilisateurs vers la page du Dashboard qui affiche votre application, vous avez besoin d’une application qui propose des fonctionnalités d’interface utilisateur.

Créer l'URL du lien profond

Pour créer l’URL du lien profond, vous devez utiliser :

L’ID du compte Stripe où votre application est installée. Pour en savoir plus, consultez la section Contexte utilisateur.
L’URL d’une page du Dashboard pour laquelle vous avez défini une vue
Le paramètre apps pour spécifier votre application et où l’ouvrir.
ID de votre application, spécifié dans le champ ID de votre fichier de manifeste stripe-app.json.

Remarque

Un ancien format utilisant le paramètre open_drawer_app continue de fonctionner pour la rétrocompatibilité, mais le format moderne du paramètre apps est recommandé.

Format deep link

La structure d’une URL deep link est :

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

Où :

MODE : test pour le mode test, ou rien pour le mode production
ACCOUNT_ID : l’ID du compte Stripe (commençant par acct_)
PAGE : la page du Dashboard à afficher (par exemple customers, invoices ou dashboard)
APP_ID : l’ID de votre application dans votre fichier de manifeste
TARGET : où ouvrir votre application, par exemple drawer ou modal
VIEWPORT_ID : les ID de Viewport configurés dans votre fichier de manifeste (par exemple, stripe.dashboard.payment.list)

Exemples

Si vous définissez une vue sur la page Clients du Dashboard (https://dashboard.stripe.com/test/customers?) et que l’ID de votre application est com.example.my-app :

Le lien profond du test mode et de l’environnement de test est le suivant :

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

Le lien profond du mode production est le suivant :

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

Vous pouvez ouvrir votre application sur n’importe quelle page du Dashboard où vous avez défini une vue. Par exemple, pour ouvrir sur l’accueil du Dashboard :

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

Pour créer un deep link vers votre onbarding modal, utilisez modal au lieu de drawer :

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

Vérifiez que vous utilisez l’URL du mode de production lorsque vous partagez un lien profond avec vos utilisateurs. Vous pouvez partager ce lien à votre guise avec les utilisateurs ayant installé votre application. Si l’utilisateur n’a pas installé votre application avant de cliquer sur le lien profond, Stripe le redirige vers une application privée qui ne peut pas être ouverte dans le Dashboard.

Tester le lien profond

Connectez-vous au Dashboard en tant qu’utilisateur ayant installé l’application.
Cliquez sur le lien profond.
S’il vous redirige vers une application qui ne peut pas s’ouvrir, assurez-vous que :
- Le paramètre apps utilise le bon ID d’application de votre manifeste
- L’ID du compte dans le chemin de l’URL est correct (format : acct_ suivi de caractères alphanumériques)
- L’utilisateur a bien installé l’application pour ce compte
- La page du Dashboard dans l’URL a une vue définie pour votre application