Mit der öffentlichen JeriCommerce-API können Ihre eigenen Systeme mit Ihrem Treueprogramm arbeiten. Sie ist für jedes Programm verfügbar: Sie brauchen nur einen API-Schlüssel.

Die API deckt zwei Arten von Aufgaben ab:

  • Loyalty-Aktionen: Punkte vergeben, Coupons zuweisen, Prämien einlösen, Wallet-Push-Benachrichtigungen senden und Kundendaten lesen. Jede Aktion ist unter Automatisierungen beschrieben, mit einem Tab API neben den Optionen für Shopify Flow und Klaviyo. So können Sie die Kanäle vergleichen und Ihre Anfrage erstellen.
  • Referenz-Endpunkte: die auf dieser Seite aufgeführten, etwa der Prämienkatalog oder die Punktevorschau.

Wenn Ihr eigenes System die maßgebliche Quelle für Kunden und Punktestände sein und jedes Kundenereignis empfangen soll, richten Sie stattdessen die Custom-API-Integration ein. Sie muss in JeriCommerce aktiviert werden und arbeitet zusammen mit dieser API.

Basis-URL

Alle Endpunkte liegen unter Ihrem Programm:

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

Ersetzen Sie {program_slug} durch Ihren Program-Slug oder Ihre Program ID. Beides funktioniert. Sie finden beides in JeriCommerce unter Settings > Technical > Program Information.

Authentifizierung

Senden Sie Ihren API-Schlüssel bei jeder Anfrage im Header api-key. Schlüssel gehören zu einem Programm und funktionieren nur mit diesem Programm. Wie Sie einen erstellen, steht unter Authentifizierung über die API.

Konventionen für Anfragen

  • Anfrage- und Antwort-Bodys sind JSON. Senden Sie Content-Type: application/json.
  • Kunden werden anhand ihrer E-Mail-Adresse identifiziert. Bei E-Mail-Adressen wird nicht zwischen Groß- und Kleinschreibung unterschieden.
  • Die meisten Schreib-Endpunkte akzeptieren ein Array von Einträgen, sodass Sie mit einem Aufruf viele Kunden bearbeiten können. Das Limit liegt bei 100 Einträgen pro Anfrage, bei der Synchronisierung von Kunden oder Loyalty-Informationen über die Custom-API-Integration bei 250.

Endpunkte mit Warteschlange

Increase balance, Decrease balance, Redeem a reward, Assign a coupon und Send a push notification stellen jeden Eintrag in eine Warteschlange und antworten sofort mit 201. Ein 201 bedeutet, dass die Anfrage gültig war, nicht dass jeder Eintrag erfolgreich war. Schlägt ein Eintrag später fehl (zum Beispiel, weil der Kunde nicht existiert oder nicht genug Punkte hat), meldet die API das nicht. Um das Ergebnis zu prüfen, lauschen Sie auf den Events-Webhook oder lesen Sie den Kunden mit Kundendetails abrufen.

Die übrigen Endpunkte werden sofort ausgeführt und geben das Ergebnis oder einen Fehler in der Antwort zurück.

Fehler

Fehler geben einen HTTP-Statuscode und einen JSON-Body zurück. Das Feld message enthält einen Code, den Sie in Ihrer Integration verwenden können:

{
  "statusCode": 404,
  "message": "CUSTOMER_NOT_FOUND",
  "path": "/v1/programs/your-program/customers/someone@example.com",
  "timestamp": "2026-10-11T09:00:00.000Z"
}

Ist der Anfrage-Body ungültig, lautet der Status 400 und message ist eine Liste der Felder, die die Validierung nicht bestanden haben.

Status Bedeutung
400 Die Anfrage ist ungültig: ein Feld fehlt oder ist falsch, oder es gibt zu viele Einträge.
403 Der API-Schlüssel fehlt oder gehört nicht zu diesem Programm, oder die API-Integration ist nicht aktiv.
404 Das Programm oder der Kunde existiert nicht.
412 Dem Kunden fehlt etwas, das die Aktion benötigt, zum Beispiel eine Treuekarte.

Endpunkte

Endpunkt Was er macht
Kundendetails abrufen Profil, Punktestand und Stufe eines Kunden lesen.
Punktestand erhöhen und verringern Punkte hinzufügen oder abziehen.
Eigene Sammelaktion ausführen Punkte über eine Ihrer eigenen Sammelaktionen vergeben.
Prämie einlösen Die Punkte eines Kunden gegen eine Prämie eintauschen.
Coupon zuweisen Einem Kunden einen Coupon geben.
Push-Benachrichtigung senden Eine Wallet-Push-Benachrichtigung an einen Kunden senden.
Downloadlink abrufen Einen Downloadlink für die Treuekarte erstellen.
Punktevorschau Berechnen, wie viele Punkte ein Bestellwert einbringen würde.
Prämien auflisten Den Prämienkatalog des Programms abrufen.
Kundentokens Tokens für Downloadlinks und Sitzungslinks der Kunden-App erstellen.

Die Custom-API-Integration ergänzt Endpunkte zum Synchronisieren von Kunden und Loyalty-Informationen sowie den Events-Webhook.