Shell und API Explorer

Verwenden Sie eine Befehlszeilenschnittstelle, um Ihre Integration zu verwalten und APIs kennenzulernen.

Shell ist eine Befehlszeilenschnittstelle in Workbench, die viele der in die Stripe-CLI integrierten Befehle bereitstellt. Bei Verwendung von Workbench ist immer eine minimierte Shell am unteren Rand des Bereichs verfügbar. Sie können auch die Registerkarte Shell verwenden, um eine Vollbildsitzung zu starten.

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

Melden Sie sich im Dashboard an und klicken Sie im Menü Entwickler auf Workbench. Wechseln Sie dann zur Registerkarte **Shell **.

Häufiger Fehler

Die Shell ist im Live-Modus schreibgeschützt. Wechseln Sie zu einer Sandbox, um API-Anfragen auszuführen, die API-Objekte erstellen, ändern oder löschen.

Ereignisse überwachen

Geben Sie stripe listen in das Eingabefeld ein, um Webhook-Ereignisse zu überwachen. Drücken Sie dann die Eingabetaste auf Ihrer Tastatur, um den Befehl auszuführen.

Command Line

stripe listen

Dadurch werden eingehende Ereignisse für Ihr Stripe-Konto überwacht

Ihre erste API-Anfrage ausführen

Klicken Sie auf Neuer Bereich, um eine neue Sitzung in einem Bereich neben Ihrer bestehenden Sitzung zu öffnen.
Kopieren Sie den Befehl, fügen Sie ihn in das Eingabefeld ein und drücken Sie dann die Eingabetaste auf Ihrer Tastatur.
Kopieren Sie die Objektkennung (in id) aus der Antwort für nachfolgende Anfragen.

Command Line
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

Klicken Sie auf API-Explorer, um den interaktiven API-Explorer auf der rechten Seite anzuzeigen.
Wählen Sie die Ressource Products und die Methode Update 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 Pfadargument id 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

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