Explorateur API et shell

Utilisez une interface de ligne de commande pour gérer votre intégration et explorer les API.

Shell est une interface de ligne de commande dans Workbench qui fournit la plupart des commandes intégrées à l’interface de ligne de commande Stripe. Lorsque vous utilisez Workbench, une interface de commande minimale est toujours disponible en bas du volet. Vous pouvez également utiliser l’onglet Shell pour lancer une session en plein écran.

Utilisez les fonctionnalités du shell suivantes pour vous aider à gérer et à déboguer votre intégration Stripe :

Saisie semi-automatique : le shell permet de remplir automatiquement les requêtes API et les commandes de l’interface de ligne de commande via la touche Tab.
** Explorateur d’API :** utilisez l’explorateur d’API intégré pour parcourir visuellement les références de l’API et exécuter des appels à l’API à partir du shell.

Remarque

Puisque le shell s’exécute dans le navigateur, il présente certaines limites par rapport à l’interface de ligne de commande Stripe, qui peut recevoir et déclencher des événements webhook sur votre machine locale à l’aide d’un écouteur d’événements local. Pour en savoir plus, consultez la section Tester une intégration de webhooks avec l’interface de ligne de commande Stripe.

Configuration initiale

Connectez-vous au Dashboard. Dans le menu Développeurs, cliquez sur Workbench. Accédez à l’onglet Shell.

Erreur fréquente

Le shell est en lecture seule en mode production. Passez à un environnement de test pour exécuter des requêtes à l’API qui créent, modifient ou suppriment des objets de l’API.

Écouter les événements

À l’invite de la ligne de commande, tapez stripe listen pour écouter les événements de webhook, puis appuyez sur la touche Entrée de votre clavier pour exécuter la commande.

Command Line

stripe listen

Cela permet d’écouter les événements entrants pour votre compte Stripe.

Exécuter votre première requête API

Cliquez sur Nouveau volet pour ouvrir une nouvelle session dans un volet à côté de votre session existante.
Copiez la commande, collez-la dans l’invite de la ligne de commande, puis appuyez sur la touche Entrée de votre clavier.
Copiez l’identifiant de l’objet (dans id) de la réponse pour les requêtes suivantes.

Command Line
stripe products create \
--name="Introductory offer (Monthly)" \
--description="$0.99 per month"

Vous créez ainsi un produit avec un nom et une description.

Utiliser l'explorateur d'API

Cliquez sur Explorateur d’API pour afficher l’explorateur d’API interactif à droite.
Choisissez la référence Products et la méthode Update. L’explorateur d’API affiche tous les paramètres obligatoires et facultatifs de la référence Produits.
Collez l’identifiant d’objet de l’étape précédente dans la valeur Value de l’argument du chemin id. Lorsque vous fournissez l’identifiant d’un objet existant à l’explorateur d’API, il charge les propriétés du produit existant.
Définissez le paramètre facultatif description sur 1,99 USD par mois. L’explorateur d’API remplit automatiquement le shell avec la commande d’API équivalente pour mettre à jour la description du produit. Appuyez sur Entrée pour exécuter la commande et mettre à jour le produit.
Cliquez sur Imprimer le code SDK pour afficher l’extrait de code équivalent dans la langue de votre choix.

Commandes disponibles

Shell fournit plusieurs commandes en plus de la commande stripe (voir la documentation sur l’interface de ligne de commande de Stripe).

Commande	Objectif
`cd`	Permet de naviguer vers d’autres pages de documentation
`clear`	Efface dans le shell tout le texte précédent
`ls`	Fournit la liste des pages du Dashboard par rapport à la page actuelle
`pwd`	Imprime le slug et le titre de la page en cours
`shortcuts`	Affiche les raccourcis clavier que vous pouvez utiliser avec le shell
`stripe`	Commandes de l’interface de ligne de commande Stripe disponibles (consulter la documentation complète)
`whoami`	Affiche les informations des marchands connectés