Stempel hinzufügen API

Die API zum Hinzufügen von Stempeln erhöht die Anzahl eines bestehenden Stempels um eins.

Wenn ein Nutzer einen Kauf, Besuch oder eine bestimmte Aktion abschließt, wird durch den API-Aufruf automatisch ein Stempel hinzugefügt.
Sobald die maximale Anzahl auf der Karte erreicht ist, werden keine weiteren Stempel hinzugefügt.

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

PUT

/api/stamp/v1/add 

{
    "stampIdx": 394
}

Request Parameters

stampIdx integer required
Stempel-IDX. 
{
    "code": 0,
    "message": "",
    "result": null
}

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 null

Warum diese API zentral ist

Während die Create-API die Karte erstellt, erfasst die Add-API die tatsächlichen Nutzeraktionen.

Jeder Kauf oder Besuch wird erfasst und ermöglicht ein verhaltensbasiertes Belohnungssystem ohne separates Punktesystem.

Eine einzelne API-Anfrage reicht aus, um Aktionen direkt mit der Stempelvergabe zu verknüpfen.

Verhalten bei Erreichen des Maximums

Wenn die maximale Anzahl erreicht ist, werden keine weiteren Stempel hinzugefügt.
Empfohlener Ablauf:

  1. stamps und maxStamps prüfen
  2. Wenn gleich → vollständig erreicht
  3. Update API mit useYn=Y aufrufen
  4. Stamp Create API für neuen Zyklus aufrufen
  5. Neuen Akkumulationszyklus starten

Bedingungen und Einschränkungen

Die Stempelvergabe erfolgt nicht in jedem Fall automatisch.

Folgende Bedingungen müssen erfüllt sein:

  • Stempel ist aktiv (activeYn = Y)
  • Innerhalb des gültigen Zeitraums (strtYmd ~ endYmd)
  • Maximalwert nicht erreicht (stamps < maxStamps)
  • Noch nicht eingelöst

Diese Bedingungen gewährleisten eine korrekte Vergabe gemäß den Kampagnenregeln.

Anwendungsfälle

  • Besuchsbasierte Events: Ein Stempel pro Besuch
  • Kaufbelohnung: Automatische Vergabe nach Zahlung
  • Missionsbasierte Events: Stempel nach Abschluss bestimmter Aktionen
  • Täglicher Check-in: Ein Stempel pro Login

Wichtige Punkte im Betrieb

Die Stempel-Add-API ist ein zentraler Bestandteil, der die Qualität von Kampagnen direkt beeinflusst.

  • Fehlerhafte Stempelvergabe verringert das Vertrauen in die Kampagne
  • Doppelte API-Aufrufe können zu übermäßiger Vergabe führen
  • Hat direkten Einfluss auf die Nutzererfahrung

Sollte immer zusammen mit Validierung und serverseitiger Logiksteuerung verwendet werden.