Shell und API Explorer
Verwenden Sie eine Befehlszeilenschnittstelle, um Ihre Integration zu verwalten und APIs zu erkunden.
Shell is a command line interface within Workbench that provides many of the same commands built into the Stripe CLI. When using Workbench, a minimal Shell is always available at the bottom of the pane, or use the Shell tab to launch a full-screen session.
Verwenden Sie die folgenden Shell-Funktionen, um Ihre Stripe-Integration zu verwalten und Fehler zu beheben:
- Autovervollständigung: Die Shell bietet die Registerkartenvervollständigung für API-Anforderungen und CLI-Befehle.
- API Explorer: Verwenden Sie den integrierten API Explorer, um API-Referenzen visuell zu untersuchen und API-Aufrufe von der Shell aus zu erstellen.
Notiz
Shell wird im Browser ausgeführt und weist daher im Vergleich zur Stripe-CLI, die Webhook-Ereignisse auf Ihrem lokalen Computer mit einem lokalen Ereignis-Listener auslösen kann, einige Einschränkungen auf. Weitere Informationen finden Sie unter Webhook-Integration mit der Stripe-CLI testen.
Ersteinrichtung![](https://b.stripecdn.com/docs-statics-srv/assets/fcc3a1c24df6fcffface6110ca4963de.svg)
Melden Sie sich im Dashboard an und klicken Sie im Menü Entwickler auf Workbench. Wechseln Sie dann zur Registerkarte **Shell **.
Häufiger Fehler
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.
Ereignisse überwachen![](https://b.stripecdn.com/docs-statics-srv/assets/fcc3a1c24df6fcffface6110ca4963de.svg)
- From the command line prompt, type
stripe listen
to listen for webhook events, then press Enter on your keyboard to run the command.
stripe listen
Dadurch werden eingehende Ereignisse für Ihr Stripe-Konto überwacht
Ihre erste API-Anfrage ausführen![](https://b.stripecdn.com/docs-statics-srv/assets/fcc3a1c24df6fcffface6110ca4963de.svg)
- Klicken Sie auf Neuer Bereich, um eine neue Sitzung in einem Bereich neben Ihrer bestehenden Sitzung zu öffnen.
- Copy the command, paste it into the command line prompt, then press Enter on your keyboard.
- Kopieren Sie die Objektkennung (in
id
) aus der Antwort für nachfolgende Anfragen.
stripe products create \ --name="Introductory offer (Monthly)" \ --description="$0.99 per month"
Damit wird ein Produkt mit einem Namen und einer Beschreibung erstellt.
Verwenden Sie den API Explorer![](https://b.stripecdn.com/docs-statics-srv/assets/fcc3a1c24df6fcffface6110ca4963de.svg)
- Klicken Sie auf API-Explorer, um den interaktiven API-Explorer auf der rechten Seite anzuzeigen.
- Wählen Sie die Ressource
Products
und die MethodeUpdate
aus. Der API Explorer zeigt alle erforderlichen und optionalen Parameter für die Produkte-Ressource an. - Fügen Sie die Objektkennung aus dem vorherigen Schritt in den
Value
für das Pfadargumentid
ein. Wenn Sie die Kennung eines bestehenden Objekts im API Explorer angeben, werden die Eigenschaften des bestehenden Produkts geladen. - Aktualisieren Sie den optionalen Parameter
description
auf 1,99 USD pro Monat. Der API Explorer füllt automatisch den entsprechenden API-Befehl in der Shell aus, um die Produktbeschreibung zu aktualisieren. Drücken Sie die Eingabetaste, um den Befehl auszuführen und das Produkt zu aktualisieren. - Klicken Sie auf SDK-Code drucken, um den entsprechenden Codeausschnitt in der Sprache Ihrer Wahl anzuzeigen.
Verfügbare Befehle![](https://b.stripecdn.com/docs-statics-srv/assets/fcc3a1c24df6fcffface6110ca4963de.svg)
Shell bietet zusätzlich zum Befehl stripe
mehrere Befehle (siehe Stripe-CLI-Referenz).
Befehl | Zweck |
---|---|
cd | Navigiert zu anderen Seiten der Dokumentation |
clear | Löscht alle vorherigen Texte aus der Shell |
ls | Listet Dashboard-Seiten auf, die zur aktuell geöffneten Seite passen |
pwd | Druckt den aktuellen Website-Slug und den Titel |
shortcuts | Zeigt Tastenkombinationen an, die mit Shell möglich sind |
stripe | Verfügbare Stripe-CLI-Befehle (siehe vollständige Referenz) |
whoami | Zeigt Details angemeldeter Händler an |