API-Referenz - Dodo Payments Documentation

SDKs & Libraries

Offizielle Backend-SDKs für TypeScript, Python, Go, PHP, Java, Kotlin, C#, Ruby und Rust. Diese Bibliotheken übernehmen Authentifizierung, Serialisierung und Fehlerbehandlung, damit Sie sich auf Ihre Integration konzentrieren können.

Mobile Checkout SDKs

Öffnen Sie den gehosteten Checkout von Dodo aus Android-, iOS-, React-Native- und Flutter-Apps und erhalten Sie mit einem einzigen Aufruf ein typisiertes Ergebnis zurück. Diese SDKs enthalten keinen API-Schlüssel.

Umgebungs-URLs

Testmodus: https://test.dodopayments.com
Live-Modus: https://live.dodopayments.com

Erfahre mehr über Test Mode vs Live Mode.

Authentifizierung

API-Anfragen erfordern einen API-Schlüssel, mit Ausnahme einiger öffentlicher Endpunkte wie Lizenz aktivieren, Lizenz validieren und Lizenz deaktivieren. Erstellen Sie einen in Ihrem Dashboard und fügen Sie ihn in den Authorization-Header jeder Anfrage ein.

Generate an API Key

Gehen Sie in Ihrem Dashboard zu Developer → API Keys und wählen Sie Add API Key. Erstellen Sie den Schlüssel in dem Modus, den Sie aufrufen möchten: Ein Testmodus-Schlüssel funktioniert nur mit https://test.dodopayments.com, und ein Live-Modus-Schlüssel funktioniert nur mit https://live.dodopayments.com. Geben Sie dem Schlüssel einen aussagekräftigen Namen und wählen Sie Ihre Zugriffsebene:

Schreibzugriff aktivieren aktiviert (Standard): Vollständige Lese- und Schreibberechtigungen für alle API-Operationen.
Schreibzugriff aktivieren deaktiviert: Lesezugriff. Sie können Daten (Zahlungen, Abonnements, Kunden, Produkte) abrufen, aber keine Ressourcen erstellen oder ändern.

Deaktivieren Sie Schreibzugriff aktivieren für Integrationen, die nur Daten anzeigen müssen, etwa Analysetools oder Dashboard-Integrationen.

Store Your Key Securely

Kopieren Sie den Schlüssel sofort. Sie können ihn später nicht erneut anzeigen. Speichern Sie ihn in einer Umgebungsvariable wie DODO_PAYMENTS_API_KEY.

Authenticate Requests

Fügen Sie Ihren API-Schlüssel in den Authorization-Header jeder Anfrage ein:

Authorization: Bearer YOUR_API_KEY

Legen Sie Ihren API-Schlüssel niemals in clientseitigem Code, öffentlichen Repositories oder der Versionsverwaltung offen.

Antwortformat

Erfolgreiche Anfragen geben 200 oder 201 mit einem JSON-Body oder 204 ohne Body zurück. Fehler geben einen 4xx- oder 5xx-Status mit einem JSON-Body zurück, der einen code und einen message enthält.

{
  "payment_id": "pay_gr4RizvMOXFJ6xca3y2tU",
  "status": "succeeded",
  "total_amount": 2999,
  "currency": "USD",
  "created_at": "2024-01-15T10:30:00Z"
}

{
  "code": "INVALID_REQUEST_BODY",
  "message": "Your request body is invalid. Please check your request headers and object."
}

Rate-Limits

Die API setzt gleichzeitig zwei Limits durch: ein Burst-Limit pro Sekunde und ein dauerhaftes Limit pro Minute. Die Limits gelten für Ihr gesamtes Unternehmen über alle API-Schlüssel hinweg und hängen von der Rate-Limit-Stufe Ihres Unternehmens ab.

Standardstufe

Zeitraum	Limit
Pro Sekunde (Burst)	40 Anfragen
Pro Minute (dauerhaft)	240 Anfragen

Höhere Stufen

Unternehmen mit höherem API-Bedarf können auf höhere Rate-Limits upgraden:

Stufe	Burst (pro Sekunde)	Dauerhaft (pro Minute)
Standard	40	240
Stufe 1	100	1.000
Stufe 2	500	5.000

Um Ihre Rate-Limit-Stufe zu erhöhen, senden Sie eine E-Mail an support@dodopayments.com.

Nicht authentifizierte Anfragen

Anfragen ohne gültigen API-Schlüssel werden anhand der IP-Adresse begrenzt:

Zeitraum	Limit
Pro Sekunde (Burst)	20 Anfragen
Pro Minute (dauerhaft)	100 Anfragen

Rate-Limit-Header

Antworten enthalten Header, die Ihre aktuelle Nutzung anzeigen:

X-RateLimit-Limit — Maximale Anzahl zulässiger Anfragen im aktuellen Zeitraum.
X-RateLimit-Remaining — Anzahl der verbleibenden Anfragen, bevor Sie das Limit erreichen.
X-RateLimit-Reset — Anzahl der Sekunden, bis der aktuelle Zeitraum zurückgesetzt wird.

Wenn Sie das Limit überschreiten, gibt die API 429 Too Many Requests zurück. Implementieren Sie in Ihrer Retry-Logik einen exponentiellen Backoff.

Fehlerbehandlung

Informationen zur Bedeutung eines Fehlers und zu seiner Behebung finden Sie auf den Seiten zu Fehlercodes und Transaktionsfehlern.

Error Codes

Vollständige Liste der Fehlercodes und ihrer Bedeutungen.

Transaction Failures

Häufige Transaktionsprobleme und deren Behandlung.

Webhooks

Erhalten Sie Benachrichtigungen in Echtzeit, wenn Zahlungen, Abonnements und andere Ereignisse auftreten. Richten Sie Webhooks in Ihrem Dashboard ein und verarbeiten Sie die Ereignisse, die Ihre Integration benötigt.

Webhook Guide

Richten Sie Webhooks ein, verarbeiten Sie Ereignisse und überprüfen Sie Signaturen.

Integrationsleitfäden

Beginnen Sie mit einem dieser Leitfäden, um Ihre erste Integration zu erstellen:

One-time Payments

Erstellen Sie Checkout-Sitzungen und Payment Links und verarbeiten Sie Zahlungen.

Subscriptions

Richten Sie wiederkehrende Abrechnung ein, verwalten Sie Pläne und verarbeiten Sie Lebenszyklusereignisse.

Usage-Based Billing

Messen Sie die Nutzung und stellen Sie Kunden den Verbrauch entsprechend in Rechnung.

Checkout Sessions

Erstellen Sie sichere, gehostete Checkout-Erlebnisse.

SDKs & Libraries

Mobile Checkout SDKs

​Umgebungs-URLs

​Authentifizierung

​Antwortformat

​Rate-Limits

​Standardstufe

​Höhere Stufen

​Nicht authentifizierte Anfragen

​Rate-Limit-Header

​Fehlerbehandlung

Error Codes

Transaction Failures

​Webhooks

Webhook Guide

​Integrationsleitfäden

One-time Payments

Subscriptions

Usage-Based Billing

Checkout Sessions

Umgebungs-URLs

Authentifizierung

Antwortformat

Rate-Limits

Standardstufe

Höhere Stufen

Nicht authentifizierte Anfragen

Rate-Limit-Header

Fehlerbehandlung

Webhooks

Integrationsleitfäden