Stempelprüfung

Diese API wird verwendet, um die Gültigkeit eines Stempels zu überprüfen, bevor Stempel hinzugefügt, entfernt oder Belohnungen eingelöst werden.

Die Validierung erfolgt nach den folgenden Kriterien:

  • Gültigkeit des Stamp IDX
  • Gültigkeitszeitraum des Stempels
  • Aktivierungsstatus des Stempels
  • Ob die Belohnung bereits eingelöst wurde

Diese API ist für Personal- und höhere Tarife verfügbar.

GET

/api/stamp/v1/validate?stampIdx={stampIdx}

{
    "stampIdx": 274
}

Request Parameters

stampIdxintegerrequired
스템프 IDX.
{
    "code": 0,
    "message": "",
    "result": {
        "stampIdx": 16,
        "domain": "https://vvd.bz",
        "cardIdx": 1,
        "cardNm": "아메리카노 10잔 적립",
        "cardTtl": "도장을 10개 모으면 아메리카노 1잔 무료",
        "stamps": 10,
        "maxStamps": 12,
        "stampUrl": "https://vvd.bz/stamp/274",
        "url": "https://myshopping.com",
        "strtYmd": "2025-01-01",
        "endYmd": "2026-12-31",
        "onsiteYn": "Y",
        "onsitePwd": "123456",
        "memo": null,
        "activeYn": "Y",
        "userId": "NKkDu9X4p4mQ",
        "userNm": null,
        "userPhnno": null,
        "userEml": null,
        "userEtc1": null,
        "userEtc2": null,
        "stampImgUrl": "https://cdn.vivoldi.com/www/image/icon/stamp/icon.stamp.1.webp",
        "regYmdt": "2025-10-30 05:11:35",
        "payloadVersion": "v1"
    }
}

Response Parameters

codeinteger
Antwortcode: 0 = Erfolgreich, jeder andere Wert = Fehler
messagestring
Antwortnachricht. Wenn der Antwortcode ungleich 0 ist, wird eine Fehlermeldung zurückgegeben.
resultobject
Wenn die Überprüfung erfolgreich ist, enthält die Antwort die Stempelinformationen.
Bei einem Fehler ist der Antwortwert null und die Fehlermeldung zeigt die Ursache an.
stampIdxinteger
Stempel-IDX.
domainstring
Stempel-Domain.
cardIdxinteger
Karten-IDX.
cardNmstring
Kartenname.
cardTtlstring
Kartentitel.
stampsinteger
Anzahl der bisher gesammelten Stempel.
maxStampsinteger
Maximale Anzahl der Stempel auf der Karte.
stampUrlstring
URL der Stempelseite.
urlstring
URL, zu der weitergeleitet wird, wenn auf der Stempelseite die Schaltfläche angeklickt wird.
strtYmddate
Beginn des Gültigkeitszeitraums des Stempels.
endYmddate
Ablaufdatum des Stempels.
onsiteYnstring
Enum:
YN
Gibt an, ob die Vor-Ort-Sammelfunktion aktiviert ist.
Wenn der Wert Y ist, kann das Personal Stempel direkt im Geschäft hinzufügen.
onsitePwdstring
Passwort für die Vor-Ort-Stempelfunktion.
Erforderlich bei der Verwendung der Stempel-Belohnungs-API, wenn die Vor-Ort-Option aktiviert ist (Y).
memostring
Interne Notiz zu Referenzzwecken.
activeYnstring
Enum:
YN
Gibt an, ob der Stempel aktiv ist.
Wenn er deaktiviert ist, kann der Kunde den Stempel nicht verwenden.
userIdstring
Benutzer-ID. Wird verwendet, um den Empfänger des Stempels zu verwalten.
Normalerweise entspricht dies der Anmelde-ID des Website-Mitglieds.
Wenn kein Wert gesetzt ist, wird die Benutzer-ID automatisch vom System generiert.
userNmstring
Benutzername. Nur für die interne Verwaltung.
userPhnnostring
Telefonnummer des Benutzers. Nur für die interne Verwaltung.
userEmlstring
E-Mail-Adresse des Benutzers. Nur für die interne Verwaltung.
userEtc1string
Zusätzliches internes Verwaltungsfeld.
userEtc2string
Zusätzliches internes Verwaltungsfeld.
stampImgUrlstring
Bild-URL des Stempels.
regYmdtdatetime
Erstellungsdatum des Stempels. Beispiel: 2025-07-21 11:50:20