WorkbenchBêta
Bêta
To enable or disable Workbench, configure the setting for your user login from the Early access features in the Dashboard.
Workbench fournit des outils de développement pour vous aider à créer, gérer et déboguer votre intégration Stripe depuis votre navigateur, n’importe où dans le Dashboard. Par exemple, à l’aide de Workbench, vous pouvez :
- Consulter un récapitulatif des erreurs d’intégration récentes
- Inspecter les objets API, les logs de requêtes, les événements et les remises de webhooks
- Exécutez des requêtes API à l’aide de l’environnement de ligne de commande intégré, ou développez-les avec l’explorateur d’API
- Créer et gérer la configuration de votre endpoint de webhook
Partagez vos idées : améliorez Workbench en cliquant sur Donner votre avis pour envoyer des demandes de fonctionnalités, des rapports de bogues et des commentaires.
Démarrer
Pour utiliser Workbench, vous devez posséder un compte Stripe et activer la version bêta des fonctionnalités en accès anticipé dans le Dashboard. Seuls les utilisateurs disposant du rôle d’administrateur ou de développeur disposent d’un accès complet à tous les outils de Workbench.
- Connectez-vous au Dashboard. Dans le menu Développeurs, cliquez sur Workbench.
- Vous pouvez faire glisser le coin supérieur du volet Workbench pour le redimensionner, ou vous pouvez cliquer sur l’icône d’agrandissement () pour passer en mode plein écran ou le quitter.
- Cliquez sur l’icône de réduction () pour réduire Workbench en barre des tâches située en bas de la page, ou sur l’icône de développement () pour rouvrir le volet. La barre des tâches vous permet d’inspecter rapidement les objets API et inclut une barre de notification qui vous avertit des erreurs critiques de l’API et de l’activité des événements.
- Pour masquer la barre des tâches de Workbench, cliquez sur l’icône de réduction () afin de réduire la barre des tâches en icône située à droite du Dashboard. Passez le curseur sur l’icône pour afficher la barre de notification. Cliquez sur l’icône pour rouvrir l’intégralité du volet Workbench.
Chaque onglet de Workbench comporte plusieurs outils. Découvrez ci-dessous les fonctionnalités de chaque onglet et la manière de les utiliser.
Note
Pour ouvrir ou réduire Workbench depuis n’importe où dans le Dashboard, appuyez sur la touche du tilde (~) sur votre clavier.
Utiliser les outils de Workbench
Gardez à l’esprit les outils suivants lorsque vous utilisez Workbench :
- Cliquez sur Copier le lien pour générer une URL partageable de la vue Workbench en cours.
- Cliquez sur Envoyer un commentaire pour partager vos idées ou questions avec l’équipe de développement principale.
Aperçu de votre intégration Stripe
Vous pouvez consulter l’activité des API de votre compte dans l’onglet Aperçu.
- Le widget État de l’intégration affiche toutes les défaillances de service connues dans l’infrastructure de Stripe.
- Le widget Clés API affiche la liste des clés standard et limitées de votre compte. Cliquez sur Gérer pour créer ou mettre à jour vos clés API.
- Le widget Versions de l’API affiche le détail des versions de l’API utilisées par les requêtes API récentes effectuées sur votre compte. Cliquez sur Mise à niveau disponible pour mettre à niveau la version de l’API par défaut de votre compte Stripe.
- Les graphiques Requêtes API et Webhooks permettent de visualiser l’activité récente de l’API sur votre compte.
- La section Données sur l’intégration affiche les améliorations pratiques que vous pouvez apporter à votre compte Stripe pour résoudre les erreurs, améliorer les performances ou mieux utiliser les API Stripe.
L’onglet Aperçu donne un aperçu rapide de l’activité API de votre compte.
Afficher les erreurs récentes
L’onglet Erreurs récapitule les erreurs récentes associées à votre compte Stripe. Vous pouvez en savoir plus sur la résolution de chaque type d’erreur d’API et consulter les logs des requêtes API récentes pour chaque erreur.
L’onglet Erreurs récapitule les erreurs d’API récentes et met en évidence les logs de requêtes associés.
Utiliser l’Inspecteur pour en savoir plus sur les objets API
Utilisez l’Inspecteur pour afficher une vue JSON des objets API de votre compte Stripe. Pour inspecter un objet, vous pouvez :
- Saisissez un ID d’objet dans l’onglet Inspecteur.
- Saisissez un ID d’objet dans la barre des tâches de Workbench.
- Accédez à une page du Dashboard pour rechercher un objet (par exemple,
Payment
,Customer
ouSubscription
), puis ouvrez l’onglet Inspecteur.
L’Inspecteur affiche une vue JSON de l’objet API, ainsi que les logs de requêtes et événements associés.
L’onglet Inspecteur affiche tous les objets API associés à gauche, ainsi qu’une vue JSON dans l’onglet Aperçu. Les onglets Logs et Événements indiquent l’activité API associée à cet objet.
Afficher les logs de requêtes API
L’onglet Logs inclut une liste des requêtes et réponses API récentes pour votre compte Stripe. Workbench met en évidence les erreurs récentes en faisant des suggestions sur la manière de les résoudre. Vous pouvez filtrer les requêtes API en fonction des éléments suivants :
- Date de la demande
- État HTTP (par exemple,
200
) - Méthode HTTP (par exemple,
POST
ouDELETE
) - Endpoint de l’API (par exemple,
/v1/checkout/sessions
) - Adresse IP à l’origine de la requête
- Source (requêtes API directes ou Dashboard)
- Compte (ou plus précisément lorsque vous utilisez Connect, les comptes de la plateforme ou les comptes connectés)
- Version de l’API (par exemple,
2020-08-27
) - Code d’erreur (par exemple,
resource_missing
) - Type d’erreur (par exemple,
invalid_request_error
) - Paramètre d’erreur (par exemple,
line_items[*][price]
)
Workbench n’actualise pas automatiquement cet onglet en temps réel lorsque votre compte reçoit de nouvelles requêtes d’API. Cliquez sur Actualiser les logs pour récupérer les derniers logs de requêtes de votre compte Stripe.
L’outil Logs présente une chronologie de l’activité de l’API , avec des filtres pour l’endpoint temporel, le code de réponse et d’autres propriétés.
Consulter les événements récents sur votre compte Stripe
L’onglet Événements inclut une liste des événements récents sur votre compte Stripe. Cliquez sur Actualiser les événements pour récupérer les derniers événements de votre compte Stripe. Vous pouvez filtrer les événements en fonction des éléments suivants :
- Date de l’événement
- État de la remise (remise ou échec)
- Type d’événement (par exemple,
customer.subscription.created
) ; vous pouvez également utiliser des caractères génériques (par exemple,customer.*
) - Ressource API (par exemple,
cus_123
)
Cliquez sur un événement dans la liste à gauche pour afficher les détails de l’événement, la charge utile et les tentatives de remise à droite. Découvrez-en plus sur la configuration des endpoints de webhook avec Workbench.
L’onglet Événements indique l’activité récente de votre compte Stripe. Les événements peuvent être remis à des endpoints de webhook.
La section Tentatives de remise répertorie les tentatives de remise de l’événement (par exemple, à un endpoint de webhook). Workbench peut répertorier plusieurs tentatives de remise si les premières tentatives ont échoué. En mode production, Stripe relance automatiquement la remise plusieurs fois. Cliquez sur Réessayer maintenant pour lancer manuellement une nouvelle tentative de remise de l’événement.
Configurer un endpoint de webhook
L’onglet Webhooks vous permet de créer un nouveau endpoint de webhook afin que Stripe puisse envoyer des événements à :
- Vos endpoints d’URL en utilisant des webhooks
- Votre ordinateur local en utilisant l’interface de ligne de commande Stripe
Cliquez sur Créer un endpoint pour configurer un nouveau endpoint de webhook auquel Stripe envoie les événements. Sélectionnez la version de l’API que Stripe utilise pour générer des événements webhook ainsi que les types d’événements à écouter, puis spécifiez une URL HTTPS où votre serveur héberge le endpoint du webhook.
À gauche, Workbench répertorie tous les endpoints de webhook configurés. L’onglet Aperçu résume l’activité sur le endpoint configuré, et l’onglet Événements envoyés fournit une liste complète des tentatives de Stripe pour envoyer des événements à ce endpoint. Cliquez sur Réessayer maintenant en regard d’une tentative d’envoi afin que Stripe puisse à nouveau envoyer l’événement à ce endpoint.
Configurez un nouveau endpoint de webhook ou envoyez les événements vers votre machine de développement locale.
Exécuter des commandes API avec le shell et l’explorateur
Le shell fournit une interface de ligne de commande permettant de gérer vos ressources Stripe dans Workbench, à l’instar de la CLI Stripe. Consultez la page Explorateur API et shell pour consulter la liste complète des commandes disponibles.
Note
Le shell est en lecture seule en mode production. Basculez vers le mode test pour exécuter des requêtes API visant à créer, modifier ou supprimer des objets API.
Lorsque vous utilisez Workbench, un shell minimal est toujours disponible dans le volet, ou vous pouvez utiliser l’onglet Shell pour lancer une session en plein écran. Dans l’onglet Shell, cliquez sur Nouveau volet pour compartimenter le volet en plusieurs sessions shell.
Cliquez sur Explorateur d’API pour afficher l’outil interactif de création de commande à droite. Choisissez la ressource API et la méthode HTTP pour afficher les paramètres obligatoires et facultatifs pour cette requête. L’onglet En-têtes permet de définir certains en-têtes HTTP, comme l’en-tête Stripe-Account
, qui permet d’effectuer des requêtes API à destination d’un compte connecté. Cliquez sur Exécuter pour exécuter la requête API.
Si vous renseignez les paramètres dans l’explorateur d’API, la commande Shell correspondante est automatiquement créée. Sélectionnez un langage de programmation, puis cliquez sur Imprimer une requête SDK pour afficher le code SDK correspondant à la requête API.
Le shell et l’explorateur d’API vous permettent de tester l’API de Stripe à partir de Workbench.