Vérification du Tampon

Cette API est utilisée pour vérifier si un tampon est valide avant d’ajouter ou de supprimer des tampons, ou de traiter l’utilisation d’un avantage.

La validation est effectuée selon les critères suivants :

  • Validité du Stamp IDX
  • Période de validité du tampon
  • État d’activation du tampon
  • Si l’avantage a déjà été utilisé

Cette API est disponible pour les forfaits Personal et supérieurs.

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
Code de réponse : 0 = Succès, toute autre valeur = Erreur
messagestring
Message de réponse. Si le code n’est pas 0, un message d’erreur correspondant est renvoyé.
resultobject
Si la vérification réussit, la réponse inclura les informations du tampon.
En cas d’échec, la valeur de la réponse sera null et le message d’erreur indiquera la cause.
stampIdxinteger
Stamp IDX.
domainstring
Domaine du tampon.
cardIdxinteger
Card IDX.
cardNmstring
Nom de la carte.
cardTtlstring
Titre de la carte.
stampsinteger
Nombre de tampons collectés jusqu’à présent.
maxStampsinteger
Nombre maximal de tampons sur la carte.
stampUrlstring
URL de la page du tampon.
urlstring
URL vers laquelle l’utilisateur est redirigé en cliquant sur le bouton de la page du tampon.
strtYmddate
Date de début de validité du tampon.
endYmddate
Date d’expiration du tampon.
onsiteYnstring
Enum :
YN
Indique si la validation sur site est activée.
Si la valeur est Y, le personnel peut ajouter des tampons directement en magasin.
onsitePwdstring
Mot de passe pour la validation sur site.
Requis lors de l’utilisation de l’API d’avantage si l’option sur site est activée (Y).
memostring
Note interne à des fins de référence.
activeYnstring
Enum :
YN
Indique si le tampon est actif.
S’il est désactivé, le client ne peut pas l’utiliser.
userIdstring
ID utilisateur. Utilisé pour gérer le bénéficiaire du tampon.
Généralement, il correspond à l’identifiant de connexion du membre du site web.
S’il n’est pas défini, un ID utilisateur est automatiquement généré par le système.
userNmstring
Nom de l’utilisateur. Usage interne uniquement.
userPhnnostring
Numéro de téléphone de l’utilisateur. Usage interne uniquement.
userEmlstring
Adresse e-mail de l’utilisateur. Usage interne uniquement.
userEtc1string
Champ supplémentaire pour la gestion interne.
userEtc2string
Champ supplémentaire pour la gestion interne.
stampImgUrlstring
URL de l’image du tampon.
regYmdtdatetime
Date de création du tampon. Exemple : 2025-07-21 11:50:20