Stempel-Erstellungs-API

Die Stempel-Erstellungs-API ermöglicht es, Stempel programmgesteuert an Kunden zu vergeben.

Geben Sie die Card IDX und das Ablaufdatum an, um einen Stempel zur ausgewählten Stempelkarte hinzuzufügen. Benutzerinformationen und Notizen können ebenfalls gespeichert werden, um die Stempelhistorie pro Kunde strukturiert zu verwalten.
Die Card IDX finden Sie auf der Seite „Stempelkarten“ im Dashboard.

Diese API ist ab dem Personal-Tarif verfügbar.

POST

/api/stamp/v1/create 

{
    "cardIdx": 123,  // You can check the IDX value on the card management page of the dashboard.
    "domain": "https://vvd.bz",
    "strtYmd": "2025-01-01",
    "endYmd": "2025-12-31",
    "activeYn": "Y",
    "memo": "New Member Registration, IP: 211.111.222.33",
    "userId": "att78z",
    "userNm": "Brown Smith",
    "userPhnno": "+1 123-4567-8900",
    "userEml": "test@gmail.com",
    "userEtc1": "Gold rating",
    "userEtc2": ""
}

Request Parameters

cardIdx integer required
Karten-IDX.
Die Karten-IDX kann auf der Seite „Stempelkarte“ im Dashboard eingesehen werden.
domain string
Default:https://vvd.bz
Stempel-Domain.
Wenn kein Wert angegeben wird, wird die Standarddomain verwendet.
Verfügbar im Premium-Tarif oder höher – Sie können eine benutzerdefinierte Domain angeben, die im Bereich „Link-Domain-Verwaltung“ registriert ist.
strtYmd date required
Startdatum der Stempelgültigkeit. Beispiel: 2025-01-01
endYmd date required
Ablaufdatum des Stempels. Beispiel: 2025-12-31
Das Ablaufdatum kann bis zu 5 Jahre ab dem heutigen Datum festgelegt werden.
activeYn string
Default:Y
Enum:
YN
Aktivierungsstatus des Stempels.
Wenn deaktiviert, können Kunden den Stempel nicht verwenden.
memo string
Interne Notiz zu Referenzzwecken.
userId string
Benutzer-ID.
Wird verwendet, um den Empfänger der Stempelausgabe zu verwalten.
Normalerweise geben Sie die Login-ID eines Website-Mitglieds ein.
Wenn nicht angegeben, wird die Benutzer-ID automatisch vom System generiert.
userNm string
Benutzername. Nur für interne Verwaltung.
userPhnno string
Telefonnummer des Benutzers. Nur für interne Verwaltung.
userEml string
E-Mail-Adresse des Benutzers. Nur für interne Verwaltung.
userEtc1 string
Zusätzliches Feld für die interne Verwaltung.
userEtc2 string
Zusätzliches Feld für die interne Verwaltung. 
{
    "code": 0,
    "message": "",
    "result": 1347
}

Response Parameters

code integer
Antwortcode: 0 = Erfolg, andere Werte = Fehler
message string
Antwortnachricht. Wenn der Code nicht 0 ist, wird eine Fehlermeldung zurückgegeben.
result integer
Antwortwert. Der generierte Stempel-IDX wird zurückgegeben.
Beispiel: 1347

Wann diese API verwenden

Diese API wird verwendet, um stempelbasierte Kampagnen und Belohnungssysteme zu erstellen.

  • Belohnungskampagnen basierend auf Besuchshäufigkeit
  • Stempelsammelprogramme im stationären Handel
  • Systeme zur Verifizierung von Nutzeraktivitäten
  • Erfassung spezifischer Aktionen (Käufe, Teilnahme usw.)

Ideal, um Nutzeraktionen zu erfassen und direkt in Belohnungen umzuwandeln.

Beziehung zwischen Stempelkarten und Stempeln

Eine Stempelkarte definiert die Regeln und das Design der Kampagne, während Stempel die Einheiten sind, die Nutzern zugewiesen werden.

Beim Aufruf der Erstellungs-API wird mit cardIdx festgelegt, welcher Karte der Stempel zugeordnet wird.

Die Card IDX ist im Dashboard verfügbar. Da jede Karte unterschiedliche Bedingungen und Belohnungen hat, ist die Auswahl der richtigen Karte entscheidend.

Struktur und Komponenten der Stempelerstellung

Ein Stempel ist nicht nur ein Datensatz, sondern eine Einheit zur Erfassung von Nutzeraktivitäten.

Wichtige Komponenten:

  • Karten-ID (cardIdx) : ID der zugehörigen Karte
  • Gültigkeitszeitraum (strtYmd, endYmd) : Zeitraum, in dem der Stempel gültig ist
  • Status (activeYn) : Gibt an, ob der Stempel aktiv und nutzbar ist
  • Nutzerinformationen (userId, userNm, userEmail, etc.) : Zielnutzer
  • Zusätzliche Felder (memo, userEtc1, userEtc2) : Individuelle Daten

Ermöglicht eine präzise und personalisierte Verwaltung von Nutzeraktivitäten.

Integration von Nutzerdaten

Das Feld userId dient zur Identifikation und Verwaltung des Empfängers des Stempels.

In der Regel wird die interne Benutzer-ID verwendet. Wird kein Wert angegeben, erstellt das System automatisch eine ID.

Durch das Hinzufügen von userNm, userPhnno und userEml können Kontaktdaten gespeichert und die Stempelaktivität pro Nutzer im Dashboard verwaltet werden.

Anwendungsfälle

  • Willkommensstempel bei Registrierung: Automatische Vergabe eines Stempels nach erfolgreicher Anmeldung durch API-Aufruf
  • Automatische Kaufbelohnung: Aufruf der API nach Zahlung, um Stempel basierend auf der Anzahl der Käufe zu vergeben
  • Zeitlich begrenzte Kampagnen: Ausstellung von Stempeln mit definierter Gültigkeit über strtYmd·endYmd
  • Erfassung von Event-Teilnahmen: Vergabe von Stempeln zur Nachverfolgung der Teilnahmehistorie
  • Belohnungskampagnen: Vergabe von Gutscheinen oder Vorteilen basierend auf gesammelten Stempeln

Unterschied zur Coupon-API

Die Coupon-API und die Stempel-API werden beide im Marketing eingesetzt, verfolgen jedoch unterschiedliche Ziele und Einsatzweisen.

Die Coupon-API ist auf Conversion ausgerichtet und fördert sofortige Käufe durch Rabatte.
Die Stempel-API konzentriert sich auf Retention, indem sie Nutzerverhalten erfasst und wiederkehrende Interaktionen fördert.

1. Zielsetzung

  • Coupon-API → Rabatt → Kaufanreiz (Conversion)
  • Stempel-API → Verhaltensdaten → Wiederkehr fördern (Retention)

Coupons eignen sich für kurzfristige Umsatzsteigerung, während Stempel die langfristige Kundenbindung stärken.

2. Einsatzzeitpunkt

  • Coupon → Vor oder während des Bezahlvorgangs
  • Stempel → Bei Aktionen (Besuch, Teilnahme etc.)

Coupons treiben den sofortigen Kauf, während Stempel zukünftige Aktionen anstoßen.

3. Datenstruktur

Coupons sind ereignisbasiert.

  • Einmalig oder begrenzt nutzbar
  • Fokus auf Rabattwert oder -satz
  • Wird bei Nutzung verbraucht oder aktualisiert

Stempel sind kumulativ.

  • Mehrfach vergebbar
  • Nutzerbezogene Akkumulation
  • Belohnung bei Zielerreichung

Kurz gesagt: Coupons sind Einmal-Trigger, Stempel sind kumulative Zustandsdaten.

4. Marketingstrategie

Coupon-basierte Strategie:

  • Neukundengewinnung
  • Steigerung der Conversion-Rate
  • Förderung bestimmter Produkte

Stempel-basierte Strategie:

  • Wiederkehr fördern
  • Kundenloyalität stärken
  • Langfristige Kampagnen

5. Kombination

In der Praxis werden beide APIs häufig kombiniert.

Beispiel:

  • Stempel sammeln (z. B. 10 Besuche)
  • Automatische Coupon-Ausgabe bei Zielerreichung
  • Kaufanreiz durch Coupon-Nutzung

Dies verbindet Engagement → Retention → Conversion in einem durchgängigen Ablauf.

Wichtige Hinweise

  • cardIdx muss eine gültige Karten-ID sein
  • Definieren Sie klare Regeln zur Vermeidung doppelter Stempel pro Nutzer
  • Falsch konfigurierte Zeiträume können die Kampagnenleistung beeinträchtigen