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

Les Environnements de test représentent l’environnement d’expérimentation propre à Stripe. Ainsi, vos utilisateurs peuvent installer des applications dans les environnements de test pour pouvoir évaluer leurs fonctionnalités.

Prise en charge de l’environnement de test général contre prise en charge de l’environnement du mode test

Stripe prend en charge deux environnements : le mode production et les environnements de test. Chaque compte Stripe dispose d’environnements de test, y compris un environnement en mode test. Ce dernier est un type unique d’environnement de test dont les caractéristiques sont différentes de celles des environnements de tests généraux. Par conséquent, votre application doit explicitement prendre en charge à la fois les environnements de test généraux et les environnements en mode test.

Vous pouvez prendre en charge les deux types d’environnements de test, chose qui incite davantage d’entreprises à évaluer votre application avant sa mise en production.

Activer la prise en charge de l’environnement de test général pour votre application

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

Vous pouvez activer l’installation en environnement de test en mettant à jour le manifeste de l’application. Une fois la prise en charge de l’environnement de test activée, envoyez votre application pour vérification. La prise en charge de l’environnement de test est vérifiée dans le cadre du processus de vérification des applications.

Environnement de test géré

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

• 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’ont pas d’influence sur les utilisateurs qui installent votre application dans un environnement de test en mode production ou en 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 l’installation de votre application publique en environnement de test général

1. Exécutez stripe apps -v pour vérifier que vous êtes sur la dernière version de laStripe CLI et du plugin Stripe Apps. Vous devez être sur la version 1.5.23 ou plus récente avant de télécharger votre application.
   Command Line

   $ stripe plugin upgrade apps
   ✔ upgrade to v1.7.0 complete.
   $ stripe -v
   stripe version 1.25.1
   $ stripe apps -v
   apps version 1.7.0

2. Mettez à jour le manifeste de l’application pour qu’il prenne en charge les installations en environnement de test.
3. (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.
4. (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
5. Chargez une nouvelle version de votre application sur votre compte principal (et non dans votre environnement de test géré).
6. À 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.
7. Créez et ouvrez un environnement de test pour tester votre application mise à jour.
8. Dans une fenêtre de navigateur, accédez au lien de test externe que vous avez créé précédemment pour installer votre application.
9. Vérifiez que votre application fonctionne comme prévu en l’installant dans un environnement de test.
10. Soumettez votre nouvelle version pour examen par la marketplace.

Mettre à jour le manifeste de l’application

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 :

{
  "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 la connexion avec un environnement de test

Lorsqu’un utilisateur installe votre application publique dans son environnement de test, une connexion est établie avec votre environnement de test géré. Ceci diffère du comportement observé lorsque votre application est installée dans un environnement de test en mode production ou en 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 environnement de test en mode production ou en mode test.

• Lorsqu’un utilisateur installe une application dans un environnement en mode test, une connexion est établie avec votre environnement en mode test.

Configurer les événements 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 les événements spécifiques à l’environnement de test.

Récupérer les 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é.

Configurer les clés API

Votre environnement de test géré possède son propre ensemble de clés API pour effectuer des appels d’installation dans l’environnement de test. Lorsque vous répondez à des webhooks ou à des événements spécifiques à l’environnement de test, vous devez utiliser ces clés d’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é.

Trouver les liens OAuth de l’environnement de test

Vous trouverez les URL OAuth de votre environnement de test en mode production et en mode test ainsi que celle de votre environnement de test général dans l’onglet Test externe dans la page 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.

1. À 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.

2. Créez un nouvel environnement de test pour tester votre application mise à jour, puis ouvrez-le.

3. Dans une nouvelle fenêtre du navigateur, accédez au lien de test externe que vous avez créé précédemment pour installer votre application.

4. Testez que votre application fonctionne comme prévu une fois installée dans un environnement de test.

Valider les clés API de l’environnement de test et le comportement des webhooks

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 en examinant les logs d’API, et en filtrant les événements. Si vous avez correctement mis à jour votre application, vous pouvez voir tous les appels API et événements webhook pour vos exemples d’actions.

Si vous ne voyez pas les événements ou les réponses attendus, vérifiez que vous êtes dans votre environnement de test géré. Vérifiez également que vous avez configuré les endpoints webhook spécifiques à votre environnement de test, et que votre application utilise les bonnes clés API d’environnement de test selon le cas.

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.