Workbench

Pour utiliser Workbench, vous devez créer un compte Stripe. Seuls les utilisateurs ayant le rôle d’Administrateur ou de Développeur ont un accès complet à tous les outils du Workbench.

1. Connectez-vous au Dashboard. Dans le menu Développeurs, cliquez sur Workbench.
2. 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.
3. 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.
4. 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.

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.

L’onglet Aperçu vous donne un aperçu de l’activité de l’API sur votre compte.

• 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 spécifiées par les requêtes API récentes adressées à 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 illustrent l’activité récente de l’API sur votre compte. Choisissez une période dans le menu déroulant et les graphiques se mettront à jour en fonction de cet intervalle de temps.
• Erreurs récentes résume les erreurs les plus récentes sur votre compte Stripe.

L’onglet Aperçu donne un aperçu rapide de l’activité API de votre compte.

L’onglet Erreurs résume les erreurs récentes sur votre compte Stripe. Vous pouvez en savoir plus sur la façon de résoudre chaque type d’erreur d’API, et consulter les logs des requêtes API récentes pour chaque erreur. Choisissez une période dans le menu déroulant pour voir les erreurs ayant eu lieu dans cet intervalle de temps.

L’onglet Erreurs récapitule les erreurs d’API récentes et met en évidence les logs de requêtes associés.

Dans le volet de gauche, les erreurs d’API sont regroupées par type d’erreur. Sélectionnez un groupe d’erreurs pour en savoir plus sur les détails de l’erreur et son impact sur votre intégration.

• Le nombre d’occurences indique la fréquence à laquelle cette erreur s’est produite au cours de la période spécifiée.
• Le chemin d’accès spécifie l’endpoint d’API utilisé pour les requêtes donnant lieu à cette erreur.
• La source spécifie l’agent utilisateur utilisé pour les requêtes aboutissant à cette erreur.
• La section Logs résume les logs de requêtes pour les erreurs d’API spécifiées. En cliquant sur l’une d’entre elles, vous obtiendrez plus de détails dans l’onglet Requêtes, qui offre une vue complète et détaillée des logs de requêtes concernés.

Utilisez l’inspecteur pour explorer une vue JSON des objets API sur votre compte Stripe. Pour inspecter un objet, vous pouvez :

• Saisissez un ID d’objet dans l’onglet Inspecteur.
• Accédez à une page du Dashboard pour n’importe quel objet (par exemple, Payment, Customer, ou `Subscription``) et cliquez sur l’icône de l’inspecteur () ou ouvrez l’onglet Inspecteur dans Workbench.

L’inspecteur affiche une vue JSON de l’objet API, ainsi que de tous les objets API, logs de requêtes et événements connexes.

Lors de l’inspection d’un objet API, l’inspecteur fournit plusieurs informations :

• Le volet de gauche présente une cartographie des données avec une hiérarchie d’objets API apparentés.
• L’onglet Aperçu offre une vue JSON de l’objet.
• L’onglet Logs affiche les logs de requêtes relatifs à l’objet.
• L’onglet Événements résume les événements récemment générés en rapport avec l’objet.

En mode test ou dans un environnement de test, l’option Modifier dans l’explorateur d’API précharge l’objet API dans l’explorateur d’API de l’onglet Interface de commande. Vous pouvez désormais mettre à jour les propriétés de l’API pour modifier l’objet.

Si l’option Analyse automatique est activée, l’inspecteur se met automatiquement à jour pour afficher les objets visibles au fur et à mesure que vous parcourez le Dashboard.

L’onglet Logs comprend une liste des requêtes et réponses récentes de l’API sur votre compte Stripe. Workbench met en évidence les erreurs récentes avec des suggestions sur la façon de les résoudre. Vous pouvez filtrer les requêtes API par :

• Date de la demande
• État HTTP (par exemple, 200)
• Méthode HTTP (par exemple, POST ou DELETE)
• 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.

L’onglet Événements comprend 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 par :

• 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)

L’onglet Événements indique l’activité récente de votre compte Stripe. Les événements peuvent être remis à des endpoints de webhook.

Cliquez sur un événement dans la liste de gauche pour en consulter les détails, la charge utile et les tentatives d’envoi sur la droite :

• Filtrez les tentatives d’envoi pour un événement spécifique en choisissant l’onglet Réussi ou En échec.
• Dans le menu de débordement (), cliquez sur Afficher l’endpoint de webhook pour voir à quelle destination cet événement a été envoyé.
• Cliquez sur Renvoyer sur une tentative d’envoi pour renvoyer cet événement à l’endpoint de webhook.

En savoir plus sur la gestion des endpoints de webhooks avec Workbench.

Vous pouvez créer un nouvel endpoint de webhook afin que Stripe puisse y envoyer des événements dans l’onglet Webhooks .

• Vos endpoints d’URL en utilisant des webhooks
• Votre machine locale à l’aide de l’interface de ligne de commande Stripe

Créer un nouvel endpoint

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.

Shell fournit une interface de ligne de commande permettant de gérer vos ressources Stripe dans Workbench, de la même manière que l’interface de ligne de commande Stripe. Consultez la page Shell et Explorateur API pour une liste complète des commandes disponibles.

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 faire apparaître le générateur de commandes interactif sur la droite. Choisissez la ressource d’API et la méthode HTTP pour afficher les paramètres requis et facultatifs pour cette requête. L’onglet En-têtes permet de configurer certains en-têtes HTTP, tels que l’en-têteStripe-Account qui permet d’effectuer des requêtes API à 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.