Stripe-CLI
Verwalten Sie Ihre Stripe-Integration im Test-Modus direkt über die Befehlszeile.
Die Stripe-CLI ist ein Entwickler-Tool, mit dem Sie Ihre Integration von Stripe direkt über die Befehlszeile aus erstellen, testen und verwalten können. Mit der Stripe-CLI können viele allgemeine Aufgaben wie das Aufrufen von Stripe APIs, das Testen Ihrer Webhooks-Integration und das Erstellen einer Anwendung ganz einfach ausgeführt werden.
Mit einem Leitfaden beginnen
Installieren Sie die Stripe-CLI unter macOS, Windows und Linux und beginnen Sie mit einem YouTube-Video von Developer Advocacy.
Automatische Vervollständigung aktivieren, damit die Stripe-CLI Ihre Befehle automatisch vervollständigt.
Erfahren Sie mehr zu Stripe-CLI-Schlüsseln, wo diese lokal gespeichert werden und wo ihre Berechtigungen zu finden sind.
Profitieren Sie von den neuesten Funktionen der Stripe-CLI.
Verwenden Sie diese Referenzleitfäden, um mehr über die CLI und die Stripe-APIs zu erfahren.
Bei Stripe anmelden, um Anfragen zu authentifizieren
Melden Sie sich an und authentifizieren Sie Ihr Stripe-Nutzerkonto, um eine Reihe von eingeschränkten Schlüsseln zu generieren. Weitere Informationen finden Sie unter Stripe-CLI-Schlüssel und -Berechtigungen.
stripe login
Drücken Sie die Eingabetaste auf der Tastatur, um den Authentifizierungsvorgang in Ihrem Browser abzuschließen.
Your pairing code is: enjoy-enough-outwit-win This pairing code verifies your authentication with Stripe. Press Enter to open the browser or visit https://dashboard.stripe.com/stripecli/confirm_auth?t=THQdJfL3x12udFkNorJL8OF1iFlN8Az1 (^C to quit)
Bei der Ausführung der Anfragen eine API-Version angeben
Wenn Sie Stripe-APIs in der CLI aufrufen, wird Ihre Standard-API-Version in allen Anfragen verwendet, die Sie in Workbench ermitteln können. Verwenden Sie die folgenden Kennzeichnungen, um verschiedene API-Versionen in der CLI auszuprobieren:
Flag | Beschreibung | Beispiel |
---|---|---|
–stripe-version 2024-11-20. | Verwenden Sie das Flag --stripe-version in einer beliebigen CLI-Anfrage, um eine API-Version anzugeben. | stripe products create --name=“My Product” --stripe-version 2024-11-20. |
--latest | Verwenden Sie das Flag --latest in einer beliebigen CLI-Anfrage, um die neueste API-Version anzugeben. | stripe products create --name="My Product" --latest |
Sie können auch eine Liste der API-Versionen einsehen.
Anfrage-Logs streamen
Verwenden Sie den Befehl stripe logs tail
, um API-Anfrage-Logs zu streamen. Lassen Sie dieses Fenster geöffnet. Wenn in Ihren API-Aufrufen ein Fehler vorhanden ist, gibt dieses Terminal die API-Fehlermeldung und einen Grund für den Fehler zurück.
stripe logs tail
Ereignisse an Ihren lokalen Webhook-Endpoint weiterleiten
Verwenden Sie das Flag --forward-to
, um alle Stripe-Ereignisse im Test-Modus an Ihren lokalen Webhook-Endpoint zu senden. Um die Verifizierung des HTTPS-Zertifikats zu überprüfen, verwenden Sie das Flag --skip-verify
.
stripe listen --forward-to localhost:4242/webhooks
Ready! Your webhook signing secret is '{{WEBHOOK_SIGNING_SECRET}}' (^C to quit)
Um bestimmte Ereignisse in einer durch Kommas getrennten Liste weiterzuleiten, verwenden Sie das Flag --events
.
stripe listen --events payment_intent.created,customer.created,payment_intent.succeeded,charge.succeeded,checkout.session.completed,charge.failed \ --forward-to localhost:4242/webhook
Falls Sie Ihren Endpoint in Stripe bereits registriert haben, können Sie die Flags --load-from-webhooks-api
und --forward-to
verwenden.
stripe listen --load-from-webhooks-api --forward-to localhost:4242
Dieser Befehl leitet Ereignisse, die an Ihren bei Stripe registrierten öffentlichen Webhook-Endpoint gesendet wurden, an Ihren lokalen Webhook-Endpoint weiter. Dadurch wird Ihr registrierter Endpoint geladen, der Pfad und die registrierten Ereignisse werden analysiert, und anschließend wird der Pfad an Ihren lokalen Webhook-Endpoint im Pfad --forward-to
angehängt. Verwenden Sie {{WEBHOOK_
aus der ursprünglichen Ausgabe des Befehls listen
, wenn Sie Webhook-Signaturen prüfen.
Alle verfügbaren Ereignisse auflisten
Verwenden Sie das Flag –help, um alle möglichen Ereignisse aufzulisten, die für eine Ereigniskategorie auftreten können. Zum Beispiel, um alle möglichen Ereignisse für die vorgefertigte Checkout-Seite für Stripe Checkout aufzulisten:
stripe trigger checkout --help
Einmaligen Produkt und Preis erstellen
- Stellen Sie eine einzelne API-Anfrage, um ein Produkt zu erstellen.
stripe products create \ --name="My First Product" \ --description="Created with the Stripe CLI"
- Suchen Sie nach der Produktkennung (in
id
) im Antwortobjekt. Speichern Sie sie für den nächsten Schritt.
Wenn alles funktioniert hat, wird in der Befehlszeile die folgende Antwort angezeigt:
{ "id":
, "object": "product","prod_LTenIrmp8Q67sa"
- Rufen Sie Preis erstellen auf, um einen Preis in Höhe von 30 USD anzufügen. Ersetzen Sie den Platzhalter in
product
durch Ihre Produktkennung (z. B.prod_
).LTenIrmp8Q67sa
stripe prices create \ --unit-amount=3000 \ --currency=usd \ --product=
{{PRODUCT_ID}}
Wenn alles funktioniert hat, wird in der Befehlszeile die folgende Antwort angezeigt:
{ "id":
, "object": "price","price_1KzlAMJJDeE9fu01WMJJr79o"
Beim Testen ein Webhook-Ereignis auslösen
Lösen Sie das Ereignis checkout.
aus, um die API-Objekte zu erstellen, die sich aus einer erfolgreich abgeschlossenen Checkout-Sitzung ergeben.
stripe trigger checkout.session.completed
Ihr stripe listen
-Terminal zeigt die folgende Ausgabe an:
Setting up fixture for: checkout_session Running fixture for: checkout_session Setting up fixture for: payment_page Running fixture for: payment_page Setting up fixture for: payment_method Running fixture for: payment_method Setting up fixture for: payment_page_confirm Running fixture for: payment_page_confirm Trigger succeeded!
Um mehr über Auslöser zu erfahren, lesen Sie unseren Leitfaden.