# 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](https://docs.stripe.com/stripe-cli.md) 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.

> Shell wird im Browser ausgeführt und weist daher im Vergleich zur [Stripe-CLI](https://docs.stripe.com/stripe-cli.md), 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](https://docs.stripe.com/webhooks.md#test-webhook).

## Ersteinrichtung

Melden Sie sich im [Dashboard](https://dashboard.stripe.com) an und klicken Sie im Menü **Entwickler** auf **Workbench**. Wechseln Sie dann zur Registerkarte **Shell **.

> Die Shell ist im Live-Modus schreibgeschützt. Wechseln Sie zu einer [Sandbox](https://docs.stripe.com/sandboxes.md), um API-Anfragen auszuführen, die API-Objekte erstellen, ändern oder löschen.

## Ereignisse überwachen

1. Geben Sie `stripe listen` in das Eingabefeld ein, um [Webhook-Ereignisse](https://docs.stripe.com/event-destinations.md#events-overview) zu überwachen. Drücken Sie dann die **Eingabetaste** auf Ihrer Tastatur, um den Befehl auszuführen.

```bash
stripe listen
```

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

## Ihre erste API-Anfrage ausführen

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

#### curl

```bash
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

1. Klicken Sie auf **API-Explorer**, um den interaktiven API-Explorer auf der rechten Seite anzuzeigen.
1. 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.
1. 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.
1. 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.
1. 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](https://docs.stripe.com/cli.md)).

| 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](https://docs.stripe.com/cli.md)) |
| `whoami`    | Zeigt Details angemeldeter Händler an                                                         |