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

stampIdx integer required
스템프 IDX. 
{
    "code": 0,
    "message": "",
    "result": {
        "stampIdx": 16,
        "domain": "https://vvd.bz",
        "cardIdx": 1,
        "cardNm": "Accumulate 10 Americanos",
        "cardTtl": "Collect 10 stamps to get one free Americano.",
        "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.
stampIdx integer
Stamp IDX.
domain string
Domaine du tampon.
cardIdx integer
Card IDX.
cardNm string
Nom de la carte.
cardTtl string
Titre de la carte.
stamps integer
Nombre de tampons collectés jusqu’à présent.
maxStamps integer
Nombre maximal de tampons sur la carte.
stampUrl string
URL de la page du tampon.
url string
URL vers laquelle l’utilisateur est redirigé en cliquant sur le bouton de la page du tampon.
strtYmd date
Date de début de validité du tampon.
endYmd date
Date d’expiration du tampon.
onsiteYn string
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.
onsitePwd string
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).
memo string
Note interne à des fins de référence.
activeYn string
Enum :
YN
Indique si le tampon est actif.
S’il est désactivé, le client ne peut pas l’utiliser.
userId string
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.
userNm string
Nom de l’utilisateur. Usage interne uniquement.
userPhnno string
Numéro de téléphone de l’utilisateur. Usage interne uniquement.
userEml string
Adresse e-mail de l’utilisateur. Usage interne uniquement.
userEtc1 string
Champ supplémentaire pour la gestion interne.
userEtc2 string
Champ supplémentaire pour la gestion interne.
stampImgUrl string
URL de l’image du tampon.
regYmdt datetime
Date de création du tampon. Exemple : 2025-07-21 11:50:20