WorkbenchBeta
Beta
To enable or disable Workbench, configure the setting for your user login from the Early access features in the Dashboard.
Workbench stellt Entwickler-Tools bereit, die Sie bei der Erstellung, Wartung und Fehlerbehebung Ihrer Stripe-Integration unterstützen. Dies geschieht direkt über den Browser, egal wo Sie sich im Dashboard befinden. Mit Workbench können Sie beispielsweise:
- Eine Übersicht neuester aufgetretener Integrationsfehler prüfen.
- API-Objekte, Anfrage-Logs, Ereignisse und Webhook-Übermittlungen überprüfen.
- API-Anfragen mit der integrierten Befehlszeilenumgebung ausführen oder mit dem API-Explorer erstellen.
- Webhook-Endpoint-Konfiguration erstellen und verwalten.
Ideen teilen: Verbessern Sie Workbench, indem Sie oben im Tool auf Feedback geben klicken und uns gewünschte Funktionen mitteilen, über Fehler informieren und Feedback geben.
Loslegen
Um Workbench nutzen zu können, benötigen Sie ein Stripe-Konto. Außerdem muss die Beta-Version mit den Funktionen für den frühzeitigen Zugriff im Dashboard aktiviert sein. Es können nur Nutzer/innen mit der Rolle Administrator oder Entwickler auf alle Workbench-Tools zugreifen.
- Melden Sie sich im Dashboard an und klicken Sie im Menü Entwickler auf Workbench.
- Um die Größe des Workbench-Bereichs zu ändern, ziehen Sie das obere Handle in die gewünschte Position. Um in den Vollbildmodus zu wechseln bzw. um diesen zu verlassen, können Sie auch auf das Symbol zum Maximieren () klicken.
- Klicken Sie auf das Symbol zum Minimieren (), um Workbench auszublenden und nur noch in einer Taskleiste am Ende der Seite anzuzeigen. Klicken Sie dann einfach auf das Symbol zum Einblenden (, um den Bereich wieder zu öffnen. Über die Taskleiste können Sie API-Objekte schnell anzeigen und Sie werden über wichtige Fehler und Ereignisaktivitäten benachrichtigt.
- Um die Workbench-Taskleiste auszublenden, klicken Sie auf das Symbol zum Ausblenden (). Dadurch wird die Taskleiste nur noch als Symbol auf der rechten Seite des Dashboards angezeigt. Bewegen Sie den Mauszeiger über das Symbol, um die Benachrichtigungsleiste anzuzeigen. Klicken Sie auf das Symbol, um den gesamten Workbench-Bereich wieder zu öffnen.
Workbench enthält mehrere Tools auf jeder Registerkarte. Im Folgenden erfahren Sie mehr über die Funktionen der einzelnen Registerkarten und wie Sie diese verwenden können.
Notiz
Um Workbench von überall aus im Dashboard zu öffnen oder zu minimieren, drücken Sie auf Ihrer Tastatur die Tilde-Taste (~).
Workbench-Tools verwenden
Bei der Verwendung von Workbench sind diese Tools hilfreich:
- Durch Klicken auf Link kopieren generieren Sie eine teilbare URL der aktuellen Workbench-Ansicht.
- Durch Klicken auf Feedback senden können Sie Ideen mit unserem Entwicklerteam teilen oder Fragen stellen.
Übersicht Ihrer Stripe-Integration
Auf der Registerkarte Übersicht sehen Sie eine Zusammenfassung der API-Aktivitäten Ihres Kontos.
- Das Widget Integrationsstatus zeigt alle bekannten Dienstverschlechterungen in der Stripe-Infrastruktur an.
- Das Widget API-Schlüssel zeigt eine Liste der Standard-Schlüssel und eingeschränkten Schlüsseln für Ihr Konto an. Klicken Sie auf Verwalten, um Ihre API-Schlüssel zu erstellen bzw. zu aktualisieren.
- Das Widget API-Versionen zeigt eine Aufschlüsselung der API-Versionen an, die in den neuesten API-Anfragen an Ihr Konto verwendet wurden. Klicken Sie auf Upgrade verfügbar, um eine Aktualisierung der Standard-API-Version Ihres Stripe-Kontos vorzunehmen.
- Die Diagramme API-Anfragen und Webhooks stellen die neuesten API-Aktivitäten in Ihrem Konto dar.
- Mit den Einblicken in die Integration werden Ihnen Verbesserungsvorschläge angezeigt, mit denen Sie Ihr Stripe-Konto optimieren. So können Sie Fehler beheben, die Leistung verbessern oder auf andere Stripe-APIs umsteigen.
Die Registerkarte „Übersicht“ zeigt eine knappe Vorschau der API-Aktivitäten Ihres Kontos.
Neueste Fehler anzeigen
Die Registerkarte Fehler fasst die neuesten Fehler in Ihrem Stripe-Konto zusammen. Sie können mehr darüber erfahren, wie Sie die verschiedenen API-Fehler beheben und die letzten API-Anfrage-Logs für jeden Fehler überprüfen.
Die Registerkarte „Fehler“ fasst die neuesten API-Fehler zusammen und weist auf die zugehörigen Anfrage-Logs hin.
Mit dem Inspector erfahren Sie mehr über API-Objekte
Über den Inspector können Sie die API-Objekte in Ihrem Stripe-Konto mittels einer JSON-Ansicht überprüfen. Um ein Objekt zu inspizieren, können Sie:
- Eine Objekt-ID auf der Registerkarte Inspector eingeben.
- Eine Objekt-ID aus der Workbench-Taskleiste eingeben.
- Auf einer Dashboard-Seite zu einem beliebigen Objekt gehen (z. B.
Payment
,Customer
oderSubscription
) und die Registerkarte Inspector öffnen.
Der Inspector zeigt eine JSON-Ansicht des API-Objekts sowie alle zugehörigen Anfrage-Logs und Ereignisse an.
Auf der Registerkarte Inspector werden auf der linken Seite alle zugehörigen API-Objekte und eine JSON-Ansicht auf der Registerkarte Übersicht angezeigt. Die Registerkarten Logs und Ereignisse zeigen die zugehörige API-Aktivität dieses Objekts an.
API-Anfrage-Logs anzeigen
Die Registerkarte Logs enthält eine Liste der neuesten API-Anfragen und Antworten für Ihr Stripe-Konto. In Workbench wird auf kürzlich aufgetretene Fehler mit Vorschlägen zur Behebung hingewiesen. Sie können API-Anfragen filtern nach:
- Datum der Anfrage
- HTTP-Status (z. B.
200
) - HTTP-Methode (z. B.
POST
oderDELETE
) - API-Endpoint (z. B.
/v1/checkout/sessions
) - IP-Adresse, die die Anfrage erstellt hat
- Quelle (direkte API-Anfragen oder Dashboard)
- Konto (oder speziell bei der Verwendung von Connect, die Plattform oder die verbundenen Konten)
- API-Version (z. B.
2020-08-27
) - Fehlercode (z. B.
resource_missing
) - Fehlertyp (z. B.
invalid_request_error
) - Fehlerparameter (z. B.
line_items[*][price]
)
Workbench aktualisiert diese Registerkarte nicht automatisch in Echtzeit, da Ihr Konto fortlaufend neue API-Anfragen erhält. Klicken Sie auf Logs aktualisieren, um die neuesten Anfrage-Logs von Ihrem Stripe-Konto abzurufen.
Das Protokoll-Tool zeigt eine Zeitleiste der API-Aktivität mit Filtern für den Zeitpunkt des Endpoints, den Antwortcode und andere Eigenschaften an.
Neueste Ereignisse in Ihrem Stripe-Konto prüfen
Die Registerkarte Ereignisse enthält eine Liste der neuesten Ereignisse in Ihrem Stripe-Konto. Klicken Sie auf Ereignisse aktualisieren, um die neuesten Ereignisse aus Ihrem Stripe-Konto abzurufen. Sie können Ereignisse filtern nach:
- Datum des Ereignisses
- Zustellungsstatus (geliefert oder fehlgeschlagen)
- Ereignistyp (z. B.
customer.subscription.created
; Sie können auch Platzhalter verwenden (z. B.customer.*
) - API-Ressource (z. B.
cus_123
)
Klicken Sie links in der Liste auf ein Ereignis, um die Details, die Nutzlast und die Übermittlungsversuche des Ereignisses auf der rechten Seite anzuzeigen. Erfahren Sie mehr darüber, wie Sie mit Workbench Webhook-Endpoints einrichten.
Auf der Registerkarte „Ereignisse“ werden die neuesten Aktivitäten Ihres Stripe-Kontos angezeigt. Die Ereignisse können an Webhook-Endpoints übermittelt werden.
Im Abschnitt Übermittlungsversuche werden alle Übermittlungsversuche des Ereignisses aufgeführt (zum Beispiel an einen Webhook-Endpoint). Workbench führt möglicherweise mehrere Übermittlungsversuche auf, wenn die ersten Versuche fehlgeschlagen sind. Im Live-Modus nimmt Stripe automatisch mehrere Übermittlungsversuche vor. Klicken Sie auf Jetzt erneut versuchen, um manuell zu versuchen, das Ereignis erneut zu übermitteln.
Einen Webhook-Endpoint einrichten
Über die Registerkarte Webhooks können Sie einen neuen Webhook-Endpoint für Stripe erstellen, um Ereignisse zu übermitteln an:
- URL-Endpoints mit Webhooks
- Ihr lokaler Computer mit der Stripe-CLI
Klicken Sie auf Neuen Endpoint erstellen, um einen neuen Webhook-Endpoint zu konfigurieren, an den Stripe Ereignisse sendet. Wählen Sie die API-Version, die Stripe zum Generieren von Webhook-Ereignissen verwendet, und die Ereignistypen, die Sie überwachen möchten. Geben Sie auch eine HTTPS-URL an, auf der Ihr Server den Webhook-Endpoint hostet.
Auf der linken Seite führt Workbench alle konfigurierten Webhook-Endpoints auf. In der Übersicht wird die Aktivität dieses konfigurierten Endpoints zusammengefasst. Die Ereignisübermittlungen zeigen in einer Liste alle Übermittlungsversuche an diesen Endpoint auf, die Stripe unternommen hat. Klicken Sie neben einem beliebigen Übermittlungsversuch auf Jetzt erneut versuchen, damit Stripe das Ereignis nochmals an diesen Endpoint übermitteln kann.
Richten Sie einen neuen Webhook-Endpoint ein oder leiten Sie Ereignisse an Ihren lokalen Entwicklungscomputer weiter.
API-Befehle mit Shell und Explorer ausführen
In der Shell können Sie ähnlich wie mit der Stripe-CLI über eine Befehlszeilenschnittstelle Ihre Stripe-Ressourcen für Workbench verwalten. Unter Shell und API-Explorer finden Sie eine Liste mit allen möglichen Befehlen.
Notiz
Die Shell ist im Live-Modus schreibgeschützt. Wechseln Sie in den Test-Modus, um API-Anfragen auszuführen und API-Objekte zu erstellen, zu ändern oder zu löschen.
Wenn Sie Workbench verwenden, ist Shell immer zumindest in einer minimierten Version aktiv. Auf der Registerkarte Shell können Sie in den Vollbildmodus wechseln. Klicken Sie auf der Registerkarte Shell auf Neuer Bereich, um den Bereich in mehrere Shell-Sitzungen zu unterteilen.
Klicken Sie auf API-Explorer, um den interaktiven Befehls-Generator auf der rechten Seite anzuzeigen. Wählen Sie die API-Ressource und die HTTP-Methode aus, um die erforderlichen und optionalen Parameter für diese Anfrage anzuzeigen. Über die Registerkarte Headers können Sie einige HTTP-Header festlegen, wie z. B. den Stripe-Account
-Header, mit dem Sie API-Anfragen an ein verbundenes Konto stellen können. Klicken Sie auf Ausführen, um die API-Anfrage auszuführen.
Wenn Parameter im API-Explorer ausgestellt werden, wird automatisch der entsprechende Shell-Befehl erstellt. Wählen Sie eine Programmiersprache aus und klicken Sie dann auf SDK-Anfrage drucken, um den entsprechenden SDK-Code für die API-Anfrage anzuzeigen.
Mit Shell und dem API-Explorer können Sie mit der Stripe-API von Workbench experimentieren.