Déployer votre application avec l’API

Une fois que Stripe a examiné et approuvé votre application pour le déploiement, nous vous en informons par e-mail par le biais d’un webhook. Vous pouvez ensuite suivre les instructions ci-dessous pour déployer votre application.

Lors du déploiement, votre application est immédiatement envoyée et téléchargée sur votre appareil. L’appareil redémarre pour installer l’application. Toutes les 24 heures, les appareils redémarrent, puis recherchent et appliquent automatiquement les mises à jour. Pour rechercher les mises à jour et les appliquer immédiatement, vous pouvez redémarrer manuellement votre appareil.

Déployez votre application sur des appareils en créant un groupe de déploiement d’appareils et en l’association à un emplacement.

Créer un groupe de déploiement d’appareils

Créez un groupe de déploiement d’appareils avec un name et un device_type spécifiques.

curl https://api.stripe.com/v1/terminal/device_deploy_groups \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Version: 2025-03-31.basil; terminal_deploy_api_beta=v1" \
  -d name=my_toy_store_ddg \
  -d device_type=stripe_s700

La réponse suivante indique un identifiant tmddg_... que vous avez utilisé pour créer le plan de déploiement.

{
  "id": "tmddg_EuEMSgeudJ0Zyw",
  "object": "terminal.device_deploy_group",
  "current_device_asset_versions": [],
  "device_type": "stripe_s700",
  "is_default": false,
  "livemode": false,
  "name": "my_toy_store_ddg"
}

Ajouter des lecteurs au groupe de déploiement d’appareils

Utilisez l’API Location pour ajouter des appareils à un groupe de déploiement d’appareils. Vous pouvez définir le champ device_deploy_groups sur un emplacement pour associer un device_type au groupe de déploiement d’appareils.

L’API Deploy prend en charge le type d’appareil stripe_s700 (utilisé par les périphériques Stripe S700 de production) et le type d’appareil stripe_s700_devkit (utilisé par les appareils DevKit).

curl https://api.stripe.com/v1/terminal/locations/tml_EUmKfAsUh3 \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Version: 2025-03-31.basil; terminal_deploy_api_beta=v1" \
  -d "device_deploy_groups[stripe_s700]"=tmddg_EuEMSgeudJ0Zyw

Lorsque vous déployez une version de ressource d’appareil sur un groupe de déploiement, l’API confirme que son paramètre compatible_device_types correspond au device_type du groupe de déploiement.

Définir l’application par défaut

Utilisez le paramètre preferred_kiosk_app pour définir l’application par défaut qui se lance sur vos appareils.

curl https://api.stripe.com/v1/terminal/deploy_plans \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Version: 2025-03-31.basil; terminal_deploy_api_beta=v1" \
  -d device_deploy_group=tmddg_EuEMSgeudJ0Zyw \
  -d "device_asset_versions_to_install[]"=tmdav_5300BozlU0005TThQ5411LAZYXcVxtG \
  -d "device_asset_versions_to_install[]"=tmdav_5300QO3Ea0005SSea9p11HdL2OHx9Vf \
  -d preferred_kiosk_app=tmda_5300slhdm0005YeJakU11De7w9i9cLi

Mettre votre application à jour

Utilisez le paramètre device_asset_versions_to_install pour mettre à jour la version des ressources de vos appareils.

curl https://api.stripe.com/v1/terminal/deploy_plans \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Version: 2025-03-31.basil; terminal_deploy_api_beta=v1" \
  -d device_deploy_group=tmddg_EuEMSgeudJ0Zyw \
  -d "device_asset_versions_to_install[]"=tmdav_5300BozlU0005TThQ5411LAZYXcVxtG \
  -d "device_asset_versions_to_install[]"=tmdav_5300QO3Ea0005SSea9p11HdL2OHx9Vf \
  -d "device_asset_versions_to_install[]"=tmdav_5300d2sWI0015SS1YVA11HdL2OHx9Vf \
  -d preferred_kiosk_app=tmda_5300slhdm0005YeJakU11De7w9i9cLi

Après avoir déployé votre application, vous pouvez suivre son avancement.

Désinstaller votre application

Utilisez le paramètre device_assets_to_uninstall pour désinstaller votre application de vos appareils.

curl https://api.stripe.com/v1/terminal/deploy_plans \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Version: 2025-03-31.basil; terminal_deploy_api_beta=v1" \
  -d device_deploy_group=tmddg_EuEMSgeudJ0Zyw \
  -d "device_asset_versions_to_install[]"=tmdav_5300BozlU0005TThQ5411LAZYXcVxtG \
  -d "device_asset_versions_to_install[]"=tmdav_5300QO3Ea0005SSea9p11HdL2OHx9Vf \
  -d "device_assets_to_uninstall[]"=tmda_5300slhdm0005YeJakU11De7w9i9cLi \
  -d preferred_kiosk_app=tmda_5300OPKai0005SiSmpV11HdL2OHx9Vf

Lancer l’application de lecteur Stripe

Vous pouvez rétablir votre groupe de déploiement d’appareils pour lancer l’application de lecteur Stripe au lieu de l’application kiosque que vous avez choisie.

Désinstallez votre application à l’aide du paramètre device_assets_to_uninstall et définissez le paramètre preferred_kiosk_app sur STRIPE_APP (sensible à la casse) en une seule requête. Assurez-vous qu’il n’y ait aucune application tierce dans le groupe de déploiement d’appareils.

curl https://api.stripe.com/v1/terminal/deploy_plans \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Version: 2025-03-31.basil; terminal_deploy_api_beta=v1" \
  -d device_deploy_group=tmddg_EuEMSgeudJ0Zyw \
  -d "device_assets_to_uninstall[]"=tmda_5300slhdm0005YeJakU11De7w9i9cLi \
  -d preferred_kiosk_app=STRIPE_APP

Supprimer des lecteurs d’un groupe de déploiement d’appareils

Pour supprimer des lecteurs d’un groupe de déploiement d’appareils, définissez le paramètre device_deploy_groups sur un emplacement pour mapper un device_type à une chaîne vide.

curl https://api.stripe.com/v1/terminal/locations/tml_EUmKfAsUh3 \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Version: 2025-03-31.basil; terminal_deploy_api_beta=v1" \
  -d "device_deploy_groups[stripe_s700]"=

Bonnes pratiques liées aux groupes de déploiement

Vous pouvez classer les appareils dans différents groupes de déploiement afin de déployer le logiciel de manière indépendante et d’isoler les défaillances en cas de problème. Le nombre de groupes de déploiement peut être plus ou moins important en fonction de votre outil, de votre tolérance au risque et des besoins de votre entreprise.

Nous recommandons la configuration de groupe de déploiement suivante :

• Alpha : contient des emplacements qui correspondent à vos kits de développement ou à vos appareils de production internes.
• ** Bêta** : contient un petit nombre d’emplacements d’utilisateurs réels. Vous pouvez choisir ces emplacements de façon aléatoire, les sélectionner en fonction de critères pertinents (par exemple, les emplacements les moins risqués) ou demander aux utilisateurs d’adhérer au groupe de déploiement Bêta en fonction de leur tolérance au risque.
• Général : contient l’ensemble des emplacements d’utilisateurs réels restants, à l’exception de ceux des groupes Alpha ou Beta. Vous pouvez utiliser un groupe de déploiement par défaut pour éviter d’affecter manuellement chaque emplacement restant.

Lorsque votre application est prête à être déployée, promouvez les groupes de déploiement du moins risqué au plus risqué :