Ihre erste Stripe API-Anfrage senden
Mit der Stripe API loslegen.
Jeder Aufruf einer Stripe-API muss einen API-Geheimschlüssel enthalten. Nachdem Sie ein Stripe-Konto erstellt haben, generieren wir zwei API-Schlüsselpaare für Sie – einen veröffentlichbaren clientseitigen Schlüssel und einen geheimen serverseitigen Schlüssel – für den Test-Modus und den Live-Modus. Um echte Geldbewegungen mit Ihren Live-Modus-Schlüsseln durchzuführen, müssen Sie Ihr Konto aktivieren.
Bevor Sie beginnen
Dieser Leitfaden führt Sie durch eine einfache Interaktion mit der Stripe API: das Erstellen einer Kundin/eines Kunden. Damit Sie die Objekte der Stripe API, und wie diese miteinander agieren, besser nachvollziehen können, führen wir Sie durch unsere API-Optionen. Mehr zu dem Thema finden Sie außerdem in der API-Dokumentation. Wenn Sie bereit sind, Zahlungen anzunehmen, lesen Sie unseren Quickstart-Leitfaden.
Ihre erste API-Anfrage senden
Sie können die Stripe-APIs mithilfe der Stripe Shell kennenlernen. Mit der Stripe Shell können Sie Stripe-CLI-Befehle direkt innerhalb der Stripe-Dokumentations-Website ausführen. Da dies nur in einer Sandbox-Umgebung betrieben wird, müssen Sie sich keine Sorgen machen, dass echte Geldbewegungen eingeleitet werden.
Geben Sie den folgenden Befehl ein, um mit Stripe Shell eine Kundin/einen Kunden zu erstellen:
Command Linestripe customers create --email=jane.smith@email.com --name="Jane Smith" --description="My First Stripe Customer"
Wenn alles funktioniert hat, wird in der Befehlszeile die folgende Antwort angezeigt:
{ "id":
, "object":"cus_LfctGLAICpokzr","customer"(Optional) Führen Sie denselben Befehl aus, indem Sie Ihren geheimen API-Schlüssel in einer Sandbox übergeben:
Command Linestripe customers create --email=jane.smith@email.com --name="Jane Smith" --description="My First Stripe Customer" --api-key sk_test_l3NrueyvQB63372N5UcJKLb2
Wenn alles funktioniert hat, wird in der Befehlszeile die folgende Antwort angezeigt:
{ "id":
, "object":"cus_LfdZgLFhah76qf","customer"
Logs und Ereignisse anzeigen
Wenn Sie Stripe-APIs aufrufen, erstellt und speichert Stripe die API- und Ereignis-Objekte für Ihr Stripe-Nutzerkonto. Der für die Anfrage angegebene API-Schlüssel bestimmt, ob die Objekte in einer Sandbox-Umgebung oder im Live-Modus gespeichert werden. Beispielsweise wurde bei der letzten Anfrage Ihr geheimer API-Schlüssel verwendet, sodass Stripe die Objekte in einer Sandbox gespeichert hat.
API-Anfrage-Log anzeigen:
- Öffnen Sie die Seite Logs.
- Klicken Sie auf 200 OK POST /v1 customers.
Ereignis-Log anzeigen:
- Öffnen Sie die Seite Ereignisse.
- Klicken Sie auf jane.smith@email.com ist eine neue Kundin.
Ihre API-Schlüssel speichern
Standardmäßig verfügen alle Konten über insgesamt vier API-Schlüssel, zwei in einer Sandbox und zwei im Live-Modus:
- Geheimer Sandbox-Schlüssel: Verwenden Sie diesen Schlüssel, um Anfragen auf Ihrem Server zu authentifizieren, wenn Sie in einer Sandbox testen. Standardmäßig können Sie diesen Schlüssel verwenden, um jede API-Anfrage ohne Einschränkung durchzuführen. Reservieren Sie diesen Schlüssel für Tests und Entwicklung, um sicherzustellen, dass Sie nicht versehentlich Ihre Live-Kunden/Kundinnen oder Zahlungen ändern.
- Veröffentlichbarer Sandbox-Schlüssel: Verwenden Sie diesen Schlüssel zu Testzwecken im clientseitigen Code Ihrer Web- oder Mobil-App. Reservieren Sie diesen Schlüssel für Tests und Entwicklung, um sicherzustellen, dass Sie nicht versehentlich Ihre Live-Kunden/Kundinnen oder Zahlungen ändern.
- Geheimschlüssel für den Live-Modus: Verwenden Sie diesen Schlüssel, um Anfragen auf Ihrem Server im Live-Modus zu authentifizieren. Standardmäßig können Sie diesen Schlüssel verwenden, um jede API-Anfrage ohne Einschränkungen durchzuführen.
- Veröffentlichbarer Schlüssel im Live-Modus: Verwenden Sie diesen Schlüssel im clientseitigen Code Ihrer Web- oder Mobil-App, wenn Sie bereit sind, Ihre App zu starten.
Ihre geheimen und veröffentlichbaren Schlüssel finden Sie im Dashboard auf der Registerkarte API-Schlüssel. Wenn Sie Ihre API-Schlüssel nicht anzeigen können, bitten Sie den/die Inhaber/in Ihres Stripe-Kontos, Sie mit den entsprechenden Berechtigungen zum Team hinzuzufügen.
Eingeschränkte API-Schlüssel
Sie können eingeschränkte API-Schlüssel im Dashboard generieren, um einen anpassbaren und eingeschränkten Zugriff auf die API zu ermöglichen. Stripe bietet jedoch standardmäßig keine eingeschränkten Schlüssel an.
Wenn Sie bei Stripe angemeldet sind, übernimmt unsere Dokumentation automatisch Ihre Test-API-Schlüssel in die Code-Beispiele. Nur Sie können diese Werte sehen. Wenn Sie nicht angemeldet sind, enthalten unsere Codebeispiele zufällig generierte API-Schlüssel. Sie können diese durch Ihre eigenen Testschlüssel ersetzen oder sich anmelden, um die Codebeispiele mit Ihren Test-API-Schlüsseln anzuzeigen.
Die folgende Tabelle zeigt zufällig generierte Beispiele für geheime und veröffentlichbare Test-API-Schlüssel:
Typ | Wert | Wann diese eingesetzt werden |
---|---|---|
Geheim | sk_ | Auf dem Server: Muss geheim und sicher im serverseitigen Code Ihrer Web- oder Mobil-App gespeichert sein (z. B. in einem Verwaltungssystem für Umgebungsvariablen oder Anmeldedaten), um Stripe-APIs aufzurufen. Stellen Sie diesen Schlüssel nicht auf einer Website zur Verfügung und betten Sie ihn nicht in eine mobile Anwendung ein. |
Veröffentlichbar | pk_ | Auf dem Client: Kann im clientseitigen Code Ihrer Web- oder Mobil-App (z. B. checkout.js) öffentlich zugänglich sein, um z. B. mit Stripe Elements Zahlungsinformationen sicher zu erfassen. Standardmäßig erfasst Stripe Checkout Zahlungsinformationen auf sichere Weise. |
Eingeschränkt | Eine Zeichenfolge, die mit rk_ beginnt. | Über Microservices: Muss geheim und sicher in Ihrem Microservice-Code gespeichert sein, um Stripe-APIs aufzurufen. Veröffentlichen Sie diesen Schlüssel nicht auf Ihrer Website und betten Sie diesen auch nicht in eine mobile Anwendung ein. |