Übersicht
Das Dodo Payments Checkout SDK bietet eine nahtlose Möglichkeit, unser Zahlungs-Overlay in Ihre Webanwendung zu integrieren. Es wurde mit TypeScript und modernen Webstandards entwickelt und bietet eine robuste Lösung für die Zahlungsabwicklung mit Echtzeit-Ereignisverarbeitung und anpassbaren Themen.
Demo
Interaktive Demo
Sehen Sie den Overlay-Checkout in Aktion mit unserer Live-Demo.
Schnellstart
Starten Sie mit dem Dodo Payments Checkout SDK in nur wenigen Codezeilen:Schritt-für-Schritt-Integrationsanleitung
SDK installieren
Installieren Sie das Dodo Payments Checkout SDK mit Ihrem bevorzugten Paketmanager:
SDK initialisieren
Initialisieren Sie das SDK in Ihrer Anwendung, typischerweise in Ihrer Hauptkomponente oder dem Einstiegspunkt der App:
Erstellen Sie eine Checkout-Button-Komponente
Erstellen Sie eine Komponente, die das Checkout-Overlay öffnet:
Fügen Sie den Checkout zu Ihrer Seite hinzu
Verwenden Sie die Checkout-Button-Komponente in Ihrer Anwendung:
Testen Sie Ihre Integration
- Starten Sie Ihren Entwicklungsserver:
- Testen Sie den Checkout-Fluss:
- Klicken Sie auf die Checkout-Schaltfläche
- Überprüfen Sie, ob das Overlay erscheint
- Testen Sie den Zahlungsfluss mit Testanmeldeinformationen
- Bestätigen Sie, dass die Weiterleitungen korrekt funktionieren
Sie sollten Checkout-Ereignisse in der Konsole Ihres Browsers protokolliert sehen.
API-Referenz
Konfiguration
Initialisierungsoptionen
| Option | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
mode | "test" | "live" | Ja | Umgebungsmodus: 'test' für Entwicklung, 'live' für Produktion |
displayType | "overlay" | "inline" | Nein | Anzeigetyp: 'overlay' für modalen Checkout (Standard), 'inline' für eingebetteten Checkout |
onEvent | function | Ja | Callback-Funktion zur Verarbeitung von Checkout-Ereignissen |
Checkout-Optionen
| Option | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
checkoutUrl | string | Ja | Checkout-Sitzungs-URL von der create checkout session API |
options.showTimer | boolean | Nein | Zeigen oder verbergen Sie den Checkout-Timer. Standardmäßig true. Wenn deaktiviert, erhalten Sie das checkout.link_expired Ereignis, wenn die Sitzung abläuft. |
options.showSecurityBadge | boolean | Nein | Zeigen oder verbergen Sie das Sicherheitsabzeichen. Standardmäßig true. |
options.manualRedirect | boolean | Nein | Wenn aktiviert, wird der Checkout nach Abschluss nicht automatisch umgeleitet. Stattdessen erhalten Sie checkout.status und checkout.redirect_requested Ereignisse, um die Umleitung selbst zu steuern. |
Methoden
Checkout öffnen
Öffnet das Checkout-Overlay mit der angegebenen Checkout-Sitzungs-URL.manualRedirect verwenden, verarbeiten Sie den Checkout-Abschluss in Ihrem onEvent Callback:
Kasse schließen
Schließt das Kassenoverlay programmgesteuert.Status überprüfen
Gibt an, ob das Kassenoverlay derzeit geöffnet ist.Ereignisse
Das SDK bietet Echtzeitereignisse, auf die Sie über denonEvent Callback hören können:
Daten zum Kassenstatus-Ereignis
WennmanualRedirect aktiviert ist, erhalten Sie das checkout.status Ereignis mit den folgenden Daten:
Daten zum angeforderten Kassenumleitungsereignis
WennmanualRedirect aktiviert ist, erhalten Sie das checkout.redirect_requested Ereignis mit den folgenden Daten:
| Ereignistyp | Beschreibung |
|---|---|
checkout.opened | Checkout-Overlay wurde geöffnet |
checkout.payment_page_opened | Zahlungsseite wurde angezeigt |
checkout.customer_details_submitted | Kunden- und Rechnungsdetails wurden übermittelt |
checkout.closed | Checkout-Overlay wurde geschlossen |
checkout.redirect | Checkout wird eine Umleitung durchführen |
checkout.error | Ein Fehler ist während des Checkouts aufgetreten |
checkout.link_expired | Wird ausgelöst, wenn die Checkout-Sitzung abläuft. Nur empfangen, wenn showTimer auf false gesetzt ist. |
checkout.status | Wird ausgelöst, wenn manualRedirect aktiviert ist. Enthält den Checkout-Status (succeeded, failed oder processing). |
checkout.redirect_requested | Wird ausgelöst, wenn manualRedirect aktiviert ist. Enthält die URL, zu der der Kunde umgeleitet werden soll. |
Implementierungsoptionen
Installation über Paketmanager
Installieren Sie über npm, yarn oder pnpm, wie im Schritt-für-Schritt-Integrationsleitfaden gezeigt.CDN-Implementierung
Für eine schnelle Integration ohne Build-Schritt können Sie unser CDN verwenden:Theme-Anpassung
Sie können das Erscheinungsbild des Checkouts anpassen, indem Sie einthemeConfig Objekt im options Parameter beim Öffnen des Checkouts übergeben. Die Themenkonfiguration unterstützt sowohl helle als auch dunkle Modi, sodass Sie Farben, Ränder, Text, Schaltflächen und den Randradius anpassen können.
Grundlegende Themenkonfiguration
Vollständige Themenkonfiguration
Alle verfügbaren Themenattribute:Nur im Lichtmodus
Wenn Sie nur das helle Thema anpassen möchten:Nur im Dunkelmodus
Wenn Sie nur das dunkle Thema anpassen möchten:Teilweise Themenüberschreibung
Sie können nur bestimmte Eigenschaften überschreiben. Der Checkout verwendet Standardwerte für Eigenschaften, die Sie nicht angeben:Themenkonfiguration mit anderen Optionen
Sie können die Themenkonfiguration mit anderen Checkout-Optionen kombinieren:TypeScript-Typen
Für TypeScript-Nutzer sind alle Typen der Themenkonfiguration exportiert:Fehlerbehandlung
Das SDK bietet detaillierte Fehlermeldungen über das Ereignissystem. Implementieren Sie immer eine ordnungsgemäße Fehlerbehandlung in IhremonEvent Callback:
Best Practices
- Einmal initialisieren: Initialisieren Sie das SDK einmal, wenn Ihre Anwendung geladen wird, nicht bei jedem Checkout-Versuch
- Fehlerbehandlung: Implementieren Sie immer eine ordnungsgemäße Fehlerbehandlung in Ihrem Ereignis-Callback
- Testmodus: Verwenden Sie den
testModus während der Entwicklung und wechseln Sie erst bei Produktionsbereitschaft zulive - Ereignisbehandlung: Behandeln Sie alle relevanten Ereignisse für ein vollständiges Benutzererlebnis
- Gültige URLs: Verwenden Sie immer gültige Checkout-URLs von der create checkout session API
- TypeScript: Verwenden Sie TypeScript für bessere Typensicherheit und Entwicklererfahrung
- Ladezustände: Zeigen Sie Ladezustände an, während der Checkout geöffnet wird, um die Benutzererfahrung zu verbessern
- Manuelle Umleitungen: Verwenden Sie
manualRedirectwenn Sie eine benutzerdefinierte Kontrolle über die Navigation nach dem Checkout benötigen - Timer-Management: Deaktivieren Sie den Timer (
showTimer: false), wenn Sie die Sitzungsablauf manuell verwalten möchten
Fehlersuche
Checkout öffnet sich nicht
Checkout öffnet sich nicht
Mögliche Ursachen:
- SDK nicht initialisiert, bevor
open()aufgerufen wird - Ungültige Checkout-URL
- JavaScript-Fehler in der Konsole
- Netzwerkverbindungsprobleme
- Überprüfen Sie, ob die SDK-Initialisierung vor dem Öffnen des Checkouts erfolgt
- Überprüfen Sie auf Konsolenfehler
- Stellen Sie sicher, dass die Checkout-URL gültig ist und von der API zum Erstellen von Checkout-Sitzungen stammt
- Überprüfen Sie die Netzwerkverbindung
Ereignisse werden nicht ausgelöst
Ereignisse werden nicht ausgelöst
Mögliche Ursachen:
- Ereignishandler nicht richtig eingerichtet
- JavaScript-Fehler verhindern die Ereignisweiterleitung
- SDK nicht korrekt initialisiert
- Bestätigen Sie, dass der Ereignishandler korrekt im
Initialize()konfiguriert ist - Überprüfen Sie die Browserkonsole auf JavaScript-Fehler
- Verifizieren Sie, dass die SDK-Initialisierung erfolgreich abgeschlossen wurde
- Testen Sie zuerst mit einem einfachen Ereignishandler
Styling-Probleme
Styling-Probleme
Mögliche Ursachen:
- CSS-Konflikte mit Ihren Anwendungsstilen
- Themen Einstellungen wurden nicht korrekt angewendet
- Probleme mit responsive Design
- Überprüfen Sie auf CSS-Konflikte in den Browser-Entwicklertools
- Überprüfen Sie, ob die Themen Einstellungen korrekt sind
- Testen Sie auf verschiedenen Bildschirmgrößen
- Stellen Sie sicher, dass keine z-index Konflikte mit Overlay bestehen
Aktivierung von digitalen Geldbörsen
Für detaillierte Informationen zur Einrichtung von Apple Pay, Google Pay und anderen digitalen Geldbörsen siehe die Seite über digitale Geldbörsen.Schnelle Einrichtung für Apple Pay
Herunterladen der Domain-Verknüpfungsdatei
Lade die Apple Pay-Domain-Verknüpfungsdatei herunter.
Aktivierungsanforderung
Sende eine E-Mail an support@dodopayments.com mit deiner Produktionsdomain-URL und fordere die Aktivierung von Apple Pay an.
Browser-Unterstützung
Das Dodo Payments Checkout SDK unterstützt die folgenden Browser:- Chrome (neueste Version)
- Firefox (neueste Version)
- Safari (neueste Version)
- Edge (neueste Version)
- IE11+
Overlay- vs. Inline-Checkout
Wähle den richtigen Checkout-Typ für deinen Anwendungsfall:| Funktion | Overlay-Checkout | Inline-Checkout |
|---|---|---|
| Integrationstiefe | Modal über der Seite | Vollständig in die Seite eingebettet |
| Layout-Kontrolle | Eingeschränkt | Volle Kontrolle |
| Branding | Getrennt von der Seite | Nahtlos |
| Implementierungsaufwand | Geringer | Höher |
| Am besten geeignet für | Schnelle Integration, bestehende Seiten | Anpassbare Checkout-Seiten, hochkonvertierende Abläufe |
Verwandte Ressourcen
Inline-Checkout
Betten Sie den Checkout direkt in Ihre Seite für vollständig integrierte Erlebnisse ein.
Checkout-Sessions-API
Erstelle Checkout-Sessions, um deine Checkout-Erlebnisse zu unterstützen.
Webhooks
Bearbeite Zahlungsereignisse serverseitig mit Webhooks.
Integrationsanleitung
Vollständige Anleitung zur Integration von Dodo Payments.