Diese Checkliste führt Sie durch alles, was Sie vor dem Start von JeriCommerce über die API-Integration benötigen. Dieser Weg ist für Teams gedacht, die Kunden- und Treuedaten auf einer eigenen Plattform verwalten und diese Daten mit JeriCommerce synchronisieren möchten, um Wallet-Pässe, Push-Benachrichtigungen und Kampagnen bereitzustellen.

Wählen Sie diesen Weg, wenn Ihr bestehender Treueanbieter oder Ihre Plattform weiterhin die Quelle für Kundendaten und Punktestände bleibt. Die Shopify-Einrichtung für ein bestehendes Programm ist speziell für LoyaltyLion vorgesehen. Wenn Sie einen anderen Anbieter verwenden, folgen Sie dieser API-Checkliste, statt ein zweites JeriCommerce-Punkteprogramm zu erstellen.

1. Überblick über Ihre Systeme

Prüfen Sie vor dem Start, welche Tools Sie verwenden werden:

  • Ihre Plattform – das System, in dem Ihre Kunden- und Treuedaten gespeichert sind (CRM, eigenes Backend, ERP usw.)
  • JeriCommerce Wallet (Installation über den Shopify App Store oder als eigenständige Einrichtung)
  • Ein Entwickler oder technisches Team, das HTTP-Anfragen an die JeriCommerce-API senden kann

Die API-Integration ist für Teams gedacht, die bereits ein Treueprogramm oder eine Kundendatenbank haben und diese mit den Wallet- und Benachrichtigungsfunktionen von JeriCommerce verbinden möchten.

2. API-Zugangsdaten erstellen

API-Schlüssel erstellen

  • Öffnen Sie im JeriCommerce-Dashboard Settings > Technical > API Keys.
  • Klicken Sie auf Create API Key, geben Sie einen Namen ein und kopieren Sie den Schlüssel. Er wird nur einmal angezeigt.

So funktioniert die API-Authentifizierung

Program Slug finden

  • Öffnen Sie Settings > Technical > Program Information.
  • Kopieren Sie Ihren Program Slug. Sie benötigen ihn in allen API-Endpunkt-URLs.

Alle API-Anfragen gehen an:

https://api.jericommerce.com/v1/programs/{program_slug}/integrations/api

3. Kunden synchronisieren

Übertragen Sie Ihre Kundendaten an JeriCommerce, damit für jeden Kunden ein Wallet-Pass erstellt werden kann.

  • Verwenden Sie den POST-Endpunkt mit feature: "users", um Kunden zu erstellen oder zu aktualisieren.
  • Pro Anfrage können bis zu 250 Kunden übertragen werden.
  • Pflichtfeld: email. Optional: firstName, lastName, phone, externalCustomerId, emailVerified.

API-Referenz für Kunden

Wenn Sie auch Treuedaten verwalten, können Sie Kunden- und Treuedatensätze in derselben Anfrage senden. Achten Sie darauf, dass der Kundeneintrag vor dem Treueeintrag steht.

4. Treuedaten synchronisieren

Wenn Ihre Plattform Punkte, Stufen oder Mitgliedschaftsstatus erfasst, synchronisieren Sie die Daten mit JeriCommerce, damit sie auf dem Wallet-Pass angezeigt werden.

  • Verwenden Sie den POST-Endpunkt mit feature: "loyalty", um Punktestand, Stufenstatus und Beitrittsdatum zu übertragen.
  • Pflichtfelder: loyaltyCustomerId, balance, memberSince.
  • Optional: tierStatus (der auf dem Wallet-Pass angezeigte Stufenname).

API-Referenz für Treuedaten

Der Kunde muss in JeriCommerce vorhanden sein, bevor Sie Treuedaten hinzufügen können. Wenn Sie beides in einer Anfrage synchronisieren, muss der Kundendatensatz vor dem Treuedatensatz stehen.

5. Webhooks einrichten (Ereignisabonnements)

Abonnieren Sie JeriCommerce-Ereignisse, damit Ihre Plattform über Vorgänge rund um den Wallet-Pass auf dem aktuellen Stand bleibt.

  • Öffnen Sie Settings > Integrations > API und geben Sie Ihre Webhook URL ein.
  • JeriCommerce sendet für alle 19 Ereignisse HTTP-POST-Anfragen an diese URL.
  • Jede Anfrage enthält zur Überprüfung eine HMAC-SHA256-Signatur im Header x-jericommerce-hmac-sha256.

Zu den Ereignissen gehören die Installation und Deinstallation von Wallet-Pässen, Änderungen des Punktestands oder der Stufe, eingelöste Prämien, Scans von Kunden bei Shopify POS und weitere.

Übersicht aller Ereignisse

6. Wallet-Pass gestalten und einrichten

Treuekarte anpassen

  • Öffnen Sie Customize → Loyalty card und wählen Sie Apple oder Google.
  • Passen Sie unter Card Grafiken und Farben Ihrer Marke an. Öffnen Sie Details, um Bereiche auf der Rückseite des Passes zu bearbeiten.

Richten Sie Bereiche und Links auf der Rückseite des Wallet-Passes ein, über die Kunden schnell Folgendes erreichen:

  • Ihre Website oder Ihr Kundenportal
  • Seiten zu Prämien, Konten oder Kundenportalen
  • Produkt- oder Landingpages

Erstellen Sie Downloadlinks, über die Ihre Kunden den Wallet-Pass installieren können.

  • Verwenden Sie die Customer Tokens API, um für jeden Kunden download-Tokens zu erstellen.
  • Das Format der Download-URL lautet: https://jeri.link/{slug}/download?token={base64Token}
  • Sie können auch auth-Tokens erstellen, die direkt zur Kunden-App führen (Prämien, Profil usw.).

Möglichkeiten zum Teilen:

  • Fügen Sie Downloadlinks in E-Mails oder SMS ein.
  • Fügen Sie sie zu Konto-, Profil- oder Web-App-Seiten hinzu.
  • Nehmen Sie sie in Abläufe nach dem Kauf auf.

8. Einzelne Bereiche für Shopify-Shop und Kundenkonto einrichten

Wenn Sie Shopify zusammen mit einer eigenen API-Integration verwenden, sind einzelne Platzierungen im Shop und Kundenkonto in der Regel sinnvoller als ein einzelner Standard-Hub. Verwenden Sie die Bereiche, die zur bereits von Ihnen gestalteten Kundenreise passen:

9. Kampagnen und Benachrichtigungen

Sobald Kunden Wallet-Pässe haben, können Sie sie mit Push-Benachrichtigungen erreichen:

Push-Benachrichtigungen

  • Informieren Sie Kunden über Sonderangebote, neue Produkte oder zeitlich begrenzte Aktionen.

So funktionieren Push-Benachrichtigungen

Standortbezogene Kampagnen

  • Lösen Sie Push-Benachrichtigungen aus, wenn Kunden in der Nähe eines Geschäfts sind.

So funktionieren standortbezogene Benachrichtigungen

10. Omnichannel — Shopify POS

Wenn Sie Einzelhandelsgeschäfte mit Shopify POS betreiben:

Sie haben alles eingerichtet und können JeriCommerce mit Ihrer API-Integration starten.