Skip to main content

Willkommen in unserem Billwerk+ Optimize Help Center

Checkout-Helfer

Einführung des Checkout Helper Tools in Billwerk+

Übersicht

Das Checkout Helper Tool in Billwerk+ ist eine optionale, aber leistungsstarke Ressource, die Entwicklern helfen soll, unsere Session API zu verstehen und damit zu arbeiten. Es ist zwar nicht obligatorisch, aber ein hervorragender Ausgangspunkt, um zu lernen, wie man sichere und effektive API-Anfragen für die Erstellung von Zahlungsfenstern konstruiert.

Ganz gleich, ob Sie einmalige Zahlungen, wiederkehrende Abrechnungen oder die Verwaltung von Abonnements integrieren möchten, der Checkout Helper dient als praktisches Lernwerkzeug, das Einblicke in die Struktur und Funktionalität der Billwerk+ Session API bietet.

Sie können navigieren, indem Sie in der Seitenleiste auf Konfigurationen > Integrationen und Tools > Checkout-Helfer klicken.

screenshot-staging-admin_billwerk_plus-2024_12_04-15_47_17.png

screenshot-staging-checkout-helper_billwerk_plus-2024_12_04-15_49_33.png

 

Warum den Checkout Helper verwenden?

Die Sessions API unterstützt die Erstellung von sicheren und anpassbaren Zahlungsfenstern. Vor dem Öffnen eines Zahlungsfensters ist ein API-Aufruf erforderlich, um eine Checkout-Sitzung zu erstellen, die einen sicheren Austausch von Parametern für Details wie Zahlungsbeträge, akzeptierte Zahlungsmethoden und Kundeninformationen gewährleistet.

Für Entwickler, die mit der API nicht vertraut sind, oder für diejenigen, die ihre Anfragen feiner abstimmen möchten, ist der Checkout Helper ein hilfreicher Weg:

  • Verstehen Sie die Anfragestruktur: Sehen Sie, wie die verschiedenen Felder den API-Parametern zugeordnet werden.

  • Experimentieren Sie mit Konfigurationen: Probieren Sie verschiedene Einstellungen aus und sehen Sie sofort, wie sie sich auf die generierte Anfrage auswirken.

  • Validieren Sie API-Aufrufe: Stellen Sie sicher, dass Ihre Aufrufe vor der Implementierung korrekt strukturiert sind.

Wann Sie den Checkout Helper verwenden sollten

Der Checkout Helper ist ideal für die ersten Phasen Ihrer Integrationsreise, wie z. B.:

  1. Erlernen der Session-API:

    Wenn Sie Billwerk+ oder APIs im Allgemeinen noch nicht kennen, erleichtert Ihnen dieses Tool das Verständnis der erforderlichen Parameter und Strukturen.

  2. Prototyping und Tests:

    Schnelle Konfiguration und Vorschau von API-Aufrufen zum Testen verschiedener Sitzungstypen oder Parameterkombinationen.

  3. Debugging-Probleme:

    Verwenden Sie das Tool, um Ihre bestehenden API-Aufrufe zu überprüfen und mögliche Probleme zu erkennen.

Was können Sie mit dem Checkout Helper tun?

Der Checkout Helper unterstützt drei Arten von Checkout-Sitzungen, die auf die Funktionalität der Session API abgestimmt sind:

  1. Sitzung aufladen:

    1. Bearbeiten Sie eine einmalige Zahlung.

    2. Optional können Sie die Zahlungsmethode für eine spätere Verwendung speichern (z. B. für wiederkehrende Zahlungen oder Abonnements).

  2. Wiederkehrende Sitzung:

    1. Speichern Sie eine Zahlungsmethode für die zukünftige Verwendung in wiederkehrenden Transaktionen oder Abonnements.

  3. Abonnement-Sitzung:

    1. Ändern Sie die Zahlungsmethode für ein bestehendes Abonnement.

    2. Aktivieren Sie ein Abonnement und verknüpfen Sie es mit einer Zahlungsmethode.

Jeder Sitzungstyp entspricht einem bestimmten Endpunkt in der Sitzungs-API, und das Tool hilft Ihnen bei der Erstellung der entsprechenden Anfrage für Ihre Bedürfnisse.

screenshot-staging-checkout-helper_billwerk_plus-2024_12_04-15_53_15.png

Hauptmerkmale des Checkout Helper

  • Vorkonfigurierte Felder: Wichtige Felder wie API-Schlüssel, Beträge, Währungen und Kundendaten sind für eine schnelle Eingabe verfügbar.

  • Generierung von Anfragen in Echtzeit: Beobachten Sie, wie das Tool die JSON-Anforderungsnutzdaten dynamisch auf der Grundlage Ihrer Eingaben erstellt.

  • Geführte Einrichtung: Das Tool bietet Kontext und Beschreibungen für jeden Parameter, damit Sie seine Rolle im API-Aufruf verstehen.

  • Ausführung von Sitzungen: Testen Sie Ihre Konfigurationen direkt über die Schnittstelle und sehen Sie sich die von der API zurückgegebenen Antworten an.

screenshot-staging-checkout-helper_billwerk_plus-2024_12_04-16_05_36.png

Verwendung des Checkout Helper

1. Zugriff auf das Tool

Öffnen Sie den Checkout Helper in der Billwerk+ Oberfläche.

2. Wählen Sie den Sitzungstyp

Wählen Sie je nach Anwendungsfall zwischen kostenpflichtigen, wiederkehrenden oder abonnierten Sitzungsarten.

3. Füllen Sie die Felder aus

Konfigurieren Sie die Sitzung, indem Sie Details wie z. B.:

  • API-Schlüssel für die Authentifizierung.

  • Gebietsschema und Währung für regionale Anpassungen.

  • Bestellbetrag und Bestelldetails für Transaktionsspezifika.

  • Kundeninformationen und bevorzugte Zahlungsmethode.

4. Überprüfen Sie die API-Anfrage

Die generierte Anfrage wird in Echtzeit angezeigt, so dass Sie ihre Struktur überprüfen und verstehen können.

5. Testen und Einstellen

Testen Sie die Sitzungserstellung, um zu sehen, wie die API antwortet. Passen Sie die Parameter nach Bedarf an, um Ihre Anfrage zu verfeinern.

Brauchen Sie den Checkout Helper?

Der Checkout Helper ist völlig optional. Wenn Sie sich mit der Session-API auskennen und lieber direkt in Ihrer Entwicklungsumgebung arbeiten, können Sie auf dieses Tool verzichten. Es kann Ihnen jedoch Zeit ersparen und Fehler reduzieren, insbesondere in der anfänglichen Einrichtungsphase.

Vorteile der Verwendung des Checkout Helper

  • Schneller lernen: Sammeln Sie praktische Erfahrungen mit der Session-API in einer geführten Umgebung.

  • Reduzieren Sie Fehler: Erstellen Sie präzise und sichere Anfragen mit Vertrauen.

  • Beschleunigen Sie die Integration: Verbringen Sie weniger Zeit mit der Fehlersuche und mehr Zeit mit der Entwicklung.

Schlussfolgerung

Der Checkout Helper in Billwerk+ ist eine praktische Ressource für Entwickler, die die Session API beherrschen möchten. Er ist zwar kein obligatorischer Schritt in Ihrem Integrationsprozess, aber ein nützliches Tool zum Erlernen, Testen und Validieren Ihrer API-Anfragen. Nutzen Sie es, um Ihre Arbeitsabläufe zu rationalisieren und sicherzustellen, dass Ihre Zahlungsfenster nahtlos funktionieren.