Activer la prise en charge de l'environnement de test pour votre application publique

Activez votre application publique pour l'installation de l'environnement de test.

Les sandboxes constituent l'environnement de test par défaut.

Le mode test n’est plus la méthode de test par défaut. Les comptes Stripe comprennent des environnements de test comme méthodes de test par défaut. Vous pouvez accéder à vos environnements de test à l’aide du sélecteur de compte ou de la page d’environnements de test de votre Dashboard.

Un environnement de test est un environnement isolé poure effectuer des tests. Utilisez votre environnement de test pour tester les fonctionnalités Stripe de votre compte et expérimenter sans affecter votre intégration en mode production. Les utilisateurs peuvent installer des applications dans un environnement de test pour évaluer leurs caractéristiques et fonctionnalités.

Prise en charge du mode test ou de l’environnement de test

Stripe prend en charge trois environnements : Environnements de test, mode production et mode test. Cependant, les environnement de test sont la méthode de test par défaut pour les nouvelles entreprises Stripe.

Nous vous recommandons vivement d’implémenter la prise en charge de l’environnement de test pour votre application afin que le plus grand nombre de marchands puisse évaluer votre application avant sa mise en production.

Activer la prise en charge de l’environnement de test pour votre application

Par défaut, les utilisateurs ne peuvent pas installer votre application publique dans un environnement de test sans travail supplémentaire.

Comme en mode test, vous pouvez activer les installations en environnement de test en actualisant le manifeste de l’application . Une fois que vous avez activé la prise en charge de l’environnement de test, soumettez votre application pour examen. La prise en charge de l’environnement de test des applications est vérifiée dans le cadre du processus d’examen des applications.

Environnement de test géré

Un environnement de test géré est un type unique d’environnement de test que Stripe crée automatiquement dans votre compte pour prendre en charge votre application publique Stripe.

Stripe crée automatiquement un environnement de test géré la première fois que vous chargez une application publique.
Lorsqu’un utilisateur installe votre application dans son environnement de test, il établit une connexion à votre environnement de test géré.
Vous pouvez déboguer et surveiller les événements à partir des installations de l’environnement de test utilisateur dans votre environnement de test géré.
Les modifications apportées à un environnement de test géré n’affectent pas les utilisateurs qui installent votre application en mode production ou mode test.
Vous ne pouvez pas supprimer un environnement de test géré.

Créer un environnement de test géré

Stripe crée automatiquement un environnement de test géré pour vous la première fois que vous chargez une application publique Stripe sur votre compte.

Pour les applications publiques chargées avant le 3 février 2025, Stripea crée automatiquement un environnement de test géré dans votre compte.

Activer les installations en environnement de test pour votre application publique

Protip

Mettez à jour le CLI Stripe et le plugin Stripe Apps vers la dernière version avant de charger votre application :

Command Line

stripe plugin upgrade apps

Mettez à jour le manifeste de l’application pour qu’il prenne en charge les installations en environnement de test.
(Facultatif) Créez des hooks d’événement spécifiques à l’environnement de test à l’intérieur de votre environnement de test géré. Mettez à jour la logique côté serveur pour écouter ces nouveaux endpoints.
(Facultatif) Mettez à jour la logique côté serveur pour utiliser les clés d’API de votre environnement de test géré lorsque vous effectuez des appels d’API Stripe pour l’installation d’un environnement de test
Chargez une nouvelle version de votre application sur votre compte principal (et non dans votre environnement de test géré).
À partir de votre compte principal, créez un lien de test externe pour la version compatible avec les environnements de test que vous venez de télécharger.
Créez et ouvrez un environnement de test pour tester votre application mise à jour.
Dans une fenêtre de navigateur, accédez au lien de test externe que vous avez créé précédemment pour installer votre application.
Vérifiez que votre application fonctionne comme prévu en l’installant dans un environnement de test.
Soumettez votre nouvelle version pour examen par la marketplace.

Mettre à jour le manifeste de l’application

Remarque

À compter du 3 février 2025, vous devez déclarer la prise en charge des environnements de test par vrai ou faux dans le manifeste de l’application pour les applications publiées sur la marketplace.

Pour prendre en charge l’installation de votre application dans un environnement de test, déclarez la prise en charge de l’environnement de test dans le manifeste de l’application à l’aide de l’attribut sandbox_install_compatible.

L’exemple de code suivant déclare la prise en charge de l’environnement de test :

stripe-app.json
{
  "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
}

Comprendre les connexions d’environnement de test

Lorsqu’un utilisateur installe votre application publique dans son environnement de test, une connexion est établie à votre environnement de test géré. Ce comportement diffère de celui observé lorsque votre application est installée en mode production ou mode test.

Lorsqu’un utilisateur installe une application dans un environnement de test, une connexion est établie à votre environnement de test géré.
Lorsqu’un utilisateur installe une application en mode production, une connexion est établie avec votre mode production et votre mode test.
Lorsqu’un utilisateur installe une application en mode test, une connexion est établie avec votre mode test.

Événements de webhook

Si votre application écoute les événements des installations de vos utilisateurs, il existe une configuration supplémentaire pour gérer les applications installées dans des environnements de test.

À l’intérieur de votre environnement de test géré, créez de nouveaux webhooks pour les événements en environnement de test.
Si un utilisateur installe votre application dans un environnement de test, Stripe envoie tous les événements applicables uniquement aux endpoints de votre environnement de test géré.
Mettez à jour votre logique côté serveur pour gérer des événements spécifiques à l’environnement de test.

Remarque

Consultez la rubrique Comportement des événements pour en savoir plus sur l’effet du mode d’installation sur le comportement des événements.

Clés secrètes de signature

Pour les webhooks, vous devrez peut-être également récupérer la clé secrète de signature depuis l’environnement de test géré.

Clés API

Votre environnement de test géré dispose de son propre jeu de clés API permettant d’effectuer des appels pour les installations en environnement de test. Lorsque vous répondez à des webhooks ou à des événements spécifiques à l’environnement de test, vous devez utiliser les clés de cet environnement de test géré.

Vous pouvez trouver les clés API appropriées pour les installations en environnement de test dans votre environnement de test géré.

Liens OAuth pour l’environnement de test

Vous trouverez vos URL OAuth de production, de test et d’environnement de test dans l’onglet Test externe des paramètres de votre application.

Si votre application utilise l’authentification RAK ou l’authentification de plateforme, aucune modification ne sera requise.

Tester votre application dans un environnement de test

Une fois que vous avez mis à jour votre application pour gérer les installations en environnement de test, vous pouvez tester votre application dans votre propre environnement de test.

Depuis votre compte principal, créez un lien de test externe pour la version activée dans l’environnement de test que vous venez de charger.
Créez un nouvel environnement de test pour tester votre application mise à jour, puis ouvrez-le.
Dans une nouvelle fenêtre de navigateur, accédez au lien de test externe que vous avez créé précédemment pour installer votre application.
Testez que votre application fonctionne comme prévu une fois installée dans un environnement de test.

Validation des clés d’API de l’environnement de test et du comportement du webhook

Vous pouvez utiliser Workbench pour vérifier que l’installation de votre environnement de test fonctionne correctement.

À l’intérieur de votre environnement de test, effectuez quelques exemples d’actions.
Ensuite, à l’intérieur de votre environnement de test géré, ouvrez Workbench.

Utilisez Workbench pour inspecter le comportement de votre application, notamment pour consulter les logs API et filtrer les événements. Si vous avez correctement mis à jour votre application, vous pouvez voir tous les appels d’API et les événements de webhook pour vos exemples d’actions.

Si les événements ou les réponses attendus ne s’affichent pas, vérifiez que vous êtes bien dans votre environnement de test géré. Vérifiez également que vous avez configuré les endpoints de webhook spécifiques à l’environnement de test et que votre application utilise les clés d’API appropriées pour cet environnement.

Envoyer votre application pour vérification

Une fois que vous avez activé la prise en charge de l’environnement de test et que vous avez validé que votre application fonctionne comme prévu dans cet environnement, vous pouvez soumettre votre application pour examen. La prise en charge de l’environnement de test des applications est vérifiée dans le cadre du processus d’examen des applications et répertoriée sur la page d’informations de votre liste d’applications.