Effectuer la migration ou créer un plugin en utilisant Stripe Apps
Auparavant, Stripe autorisait les plugins tiers à demander les clés API standard d’un utilisateur pour intégrer ses produits. Depuis janvier 2024, Stripe exige que les plugins s’appuient sur Stripe Apps. Tous les plugins nouveaux et existants doivent utiliser une application Stripe pour authentifier les utilisateurs de son service à l’aide d’Oauth 2.0 ou d’une clé API restreinte.
Si vous avez un plugin existant, migrez vers le chemin d’intégration Stripe Apps standard pour des raisons de sécurité et de conformité. La migration d’un plugin existant vers une intégration Stripe Apps nécessite uniquement de modifier la méthode d’authentification de votre plugin.
Note
Pourquoi effectuer la migration
L’authentification via une application Stripe est le nouveau chemin d’intégration par défaut pour tous les nouveaux plugins, extensions et connecteurs partenaires. Voici les avantages de ce nouveau chemin d’intégration :
- Inscription plus efficace : vos utilisateurs n’ont pas besoin de créer manuellement des clés API.
- Sécurité améliorée : des clés API limitées protègent les utilisateurs si leurs clés sont exposées.
- Analyses : bénéficiez d’une visibilité sur l’adoption et les performances de votre application.
- Visibilité : Stripe Apps offre une grande visibilité à votre produit via le Dashboard Stripe, Stripe App Marketplace et notre programme de partenariat.
- Partenaire agréé : rejoignez la section Applications à suivre dans Stripe Partner Ecosystem pour bénéficier d’avantages commerciaux, marketing et techniques.
Que se passe-t-il si vous n’effectuez pas la migration ?
Si vous choisissez de ne pas migrer votre authentification vers une application Stripe, elle continuera à fonctionner comme aujourd’hui, sans impact sur l’expérience utilisateur jusqu’en 2024. Nous continuerons à prendre en charge les plugins sur notre back-end jusqu’à la fin de l’année 2024.
Impact sur vos utilisateurs après la migration
Si vous choisissez d’effectuer la migration, vos utilisateurs doivent se réinscrire et réauthentifier leur plugin. Pour effectuer la migration ou créer un plugin, choisissez l’authentification OAuth 2.0 (recommandée) ou Restricted API Key (RAK). OAuth est le moyen le plus simple pour les utilisateurs d’authentifier un plugin en toute sécurité. L’authentification RAK ne nécessite aucune configuration supplémentaire du back-end. Cependant, les utilisateurs doivent toujours copier et coller les clés API Stripe générées dans votre plugin tiers. Cette méthode augmente la complexité du processus d’authentification pour vos utilisateurs.
Avant de commencer
- Lisez et complétez la section " Avant de commencer" de la rubrique " Démarrer avec Stripe Apps. Assurez-vous d’avoir installé la dernière version de l’interface de ligne de commande Stripe.
- Choisissez votre type d’authentification (OAuth ou RAK). Une fois votre application téléchargée, vous ne pouvez plus modifier la méthode d’authentification. Pour en savoir plus sur l’authentification, consultez la page Authentification de l’API.
- Si vous utilisez Stripe Connect et que vous souhaitez migrer un plugin existant via Stripe Apps, vous devez créer un nouveau compte Stripe. Actuellement, les comptes Stripe ayant activé Connect ne peuvent pas publier d’application.
- Vous ne pouvez créer qu’une seule application publique par compte. Si votre compte dispose déjà d’une application publique et que vous souhaitez en publier une autre, veuillez créer un nouveau compte Stripe. Vous pouvez toujours créer plusieurs applications privées sur le même compte que celui utilisé pour l’application publique.
Choisissez une méthode d’authentification pour effectuer la migration ou créer votre plugin :
Développer votre application
Créez votre application Stripe en exécutant
stripe apps create<app-name>
dans l’interface de ligne de commande.Modifiez les champs suivants dans le manifeste de l’application :
- Définissez
stripe_api_access_type
suroauth
. - Définissez
distribution_type
surpublic
. - Définissez votre
allowed_redirect_uris
. Il s’agit des URL vers lesquelles les utilisateurs sont redirigés après l’installation de votre application à l’aide d’OAuth. La première dans la liste est utilisée comme URL de redirection par défaut.
Le manifeste de votre application doit ressembler à ce qui suit :
stripe-app.json{ "id": "com.example.my-app", "version": "0.0.1", "name": "Your Stripe App", "icon": "./[YOUR_APP]_icon_32.png", "permissions": [ // Your app permissions here ], "stripe_api_access_type": "oauth", "distribution_type": "public", "allowed_redirect_uris": [ // Your redirect URIs here ] }
- Définissez
Ajoutez toutes les autorisations requises par votre application.
(Facultatif) Ajoutez des extensions d’interface utilisateur à votre application. Nous vous recommandons d’ajouter une vue des paramètres pour permettre à vos utilisateurs de configurer les paramètres ou de créer un lien vers la documentation de votre application.
Chargez votre application sur Stripe.
Command Linestripe apps upload
Tester votre application
- Accédez à la page des détails de votre application.
- Ouvrez l’onglet Test externe et cliquez sur Démarrer pour configurer un test externe.
- Accédez aux liens d’autorisation dans la section Tester OAuth. Vous pouvez utiliser ce lien pour effectuer un test avec votre propre compte.
Configurer OAuth 2.0
Assurez-vous d’avoir correctement configuré OAuth 2.0. Pour savoir comment enregistrer et actualiser les tokens d’accès, consultez la section Configuration d’OAuth.
Publier et distribuer votre application
Lorsque vous souhaitez proposer votre application aux utilisateurs :
- Soumettez votre application pour vérification.
- Une fois votre application approuvée, publiez-la sur Stripe App Marketplace.
- Dans la page de détails de l’application, cliquez sur l’onglet Paramètres.
- Copiez le lien d’installation. Les utilisateurs peuvent utiliser ce lien pour installer votre application.