Interface de ligne de commande Stripe
L’interface de ligne de commande Stripe est un outil destiné aux développeurs. Elle permet de créer, tester et gérer une intégration Stripe directement depuis la ligne de commande. Avec la CLI Stripe, il est aisé d’accomplir certaines tâches courantes telles qu’appeler les API Stripe, tester votre intégration de webhook et créer un formulaire d’inscription.
Se lancer avec un guide
Installez l’interface de ligne de commande Stripe sous macOS, Windows et Linux, et démarrez avec une vidéo YouTube de Developer Advocacy.
Activez le remplissage automatique pour que l’interface de ligne de commande Stripe remplisse automatiquement vos commandes.
Pour comprendre les clés de l’interface de ligne de commande Stripe, où elles sont sauvegardées localement et où trouver les autorisations associées.
Profitez des dernières fonctionnalités de l’interface de ligne de commande Stripe.
Appuyez-vous sur cette documentation pour découvrir l’interface de ligne de commande et les API Stripe.
Se connecter à Stripe pour authentifier les requêtes
Connectez-vous et authentifiez votre compte d’utilisateur Stripe afin de générer un jeu de clés limitées. Pour en savoir plus, consultez la documentation consacrée aux autorisations et aux clés de la CLI Stripe.
stripe login
Appuyez sur la touche Entrée de votre clavier pour effectuer le processus d’authentification dans votre navigateur.
Your pairing code is: enjoy-enough-outwit-win This pairing code verifies your authentication with Stripe. Press Enter to open the browser or visit https://dashboard.stripe.com/stripecli/confirm_auth?t=THQdJfL3x12udFkNorJL8OF1iFlN8Az1 (^C to quit)
Spécifier une version d’API lors de l’exécution de requêtes
Lorsque vous appelez les API Stripe dans la CLI, votre appel utilise votre version par défaut des API dans toutes les requêtes. Pour trouver votre version par défaut dans le Dashboard des développeurs, reportez-vous à la page Clés API. Pour tester différentes versions des API dans la CLI, utilisez les flags ci-après :
Flag | Description | Exemple |
---|---|---|
–stripe-version 2024-04-10 | Utilisez le flag --stripe-version dans votre requête CLI pour spécifier une version donnée des API. | stripe products create --name=“My Product” --stripe-version 2024-04-10 |
--latest | Utilisez le flag --latest dans votre requête CLI pour spécifier la dernière version des API. | stripe products create --name="My Product" --latest |
Vous pouvez également consulter une liste des versions des API.
Streamer les logs des requêtes
Utilisez la commande stripe logs tail
pour streamer les logs des requêtes API. Gardez cette fenêtre ouverte. Si vous avez une erreur dans vos appels API, ce terminal vous renverra le message d’erreur API et la raison de l’erreur.
stripe logs tail
Transmettre des événements à votre endpoint de webhook local
Utilisez le flag --forward-to
pour envoyer tous les événements Stripe en mode test à votre endpoint de webhook local. Utilisez le flag --skip-verify
pour désactiver la vérification des certificats HTTPS.
stripe listen --forward-to localhost:4242/stripe_webhooks
Ready! Your webhook signing secret is '{{WEBHOOK_SIGNING_SECRET}}' (^C to quit)
Pour transférer des événements spécifiques sous la forme d’une liste d’éléments séparés par des virgules, utilisez le flag --events
.
stripe listen --events payment_intent.created,customer.created,payment_intent.succeeded,charge.succeeded,checkout.session.completed,charge.failed \ --forward-to localhost:4242/webhook
Si vous avez déjà enregistré votre endpoint dans Stripe, vous pouvez utiliser les flags --load-from-webhooks-api
et --forward-to
.
stripe listen --load-from-webhooks-api --forward-to localhost:5000
Cette commande transfère les événements envoyés à votre endpoint de webhook public enregistré auprès de Stripe à votre endpoint de webhook local. Elle charge votre endpoint enregistré, analyse le chemin et ses événements enregistrés, puis ajoute le chemin à votre endpoint de webhook local dans le chemin --forward-to
. Si vous vérifiez les signatures de webhook, utilisez le paramètre {{WEBHOOK_SIGNING_SECRET}}
à partir de la sortie initiale de la commande listen
.
Dresser la liste de tous les événements disponibles
Utilisez le flag --help
pour dresser la liste de tous les événements possibles qui peuvent survenir pour une catégorie d’événement. Par exemple, pour répertorier tous les événements possibles pour la Page de paiement préconfigurée pour Stripe Checkout :
stripe trigger checkout --help
Créer un produit et un tarif ponctuels
- Effectuez une requête unique à l’API afin de créer un produit.
stripe products create \ --name="My First Product" \ --description="Created with the Stripe CLI"
- Recherchez l’identifiant produit (dans
id
) dans l’objet réponse. Conservez-le pour la prochaine étape.
Si tout a bien fonctionné, la ligne de commande affiche la réponse suivante.
{ "id":
, "object": "product","prod_LTenIrmp8Q67sa"
- Appelez l’API de création de tarif pour associer un tarif de 30 USD. Remplacez le paramètre substituable contenu dans
product
par l’identifiant de votre produit (par exemple,prod_LTenIrmp8Q67sa
).
stripe prices create \ --unit-amount=3000 \ --currency=usd \ --product=
{{PRODUCT_ID}}
Si tout a bien fonctionné, la ligne de commande affiche la réponse suivante.
{ "id":
, "object": "price","price_1KzlAMJJDeE9fu01WMJJr79o"
Déclencher un événement webhook pendant les tests
- Déclenchez l’événement
checkout.session.completed
pour créer les objets API qui résultent d’une session Checkout ayant abouti.
stripe trigger checkout.session.completed
Votre terminal stripe listen
affiche le résultat suivant :
Setting up fixture for: checkout_session Running fixture for: checkout_session Setting up fixture for: payment_page Running fixture for: payment_page Setting up fixture for: payment_method Running fixture for: payment_method Setting up fixture for: payment_page_confirm Running fixture for: payment_page_confirm Trigger succeeded!
- Déclenchez l’événement
charge.failed
pour créer les objets API résultant d’une tentative de paiement qui a échoué.
stripe trigger charge.failed
Votre terminal stripe listen
affiche le résultat suivant :
Setting up fixture for: charge Running fixture for: charge Trigger succeeded!