Modifier le Tampon

Cette API permet de modifier les informations d’un tampon existant.

Vous pouvez mettre à jour des éléments tels que le nombre de tampons collectés (stamps), l’état d’utilisation de la récompense (useYn) et l’option de réinitialisation du code PIN (resetPinYn).

Cette API est disponible à partir du forfait Personnel et supérieurs.

PUT

/api/stamp/v1/update 

{
    "stampIdx": 1457,
    "cardIdx": 172,
    "stamps": 7,
    "resetPinYn": "Y",
    "userEml": "example@gmail.com"
}

Request Parameters

stampIdxintegerrequired
Stamp IDX.
cardIdxinteger
Card IDX.
Le Card IDX peut être consulté sur la page « Carte de Tampons » du tableau de bord.
stampsinteger
Indique le nombre de tampons accumulés.
Représente le nombre total de tampons collectés par le client. La modification de cette valeur met à jour l’état d’avancement des tampons et peut être augmentée ou réduite.
Lorsque tous les tampons sont complétés (stamps = nombre maximal défini sur la carte), vous devez définir useYn sur Y pour marquer le tampon comme utilisé.
resetPinYnstring
Default :N
Enum :
YN
Spécifie si le code PIN du client pour le tampon doit être réinitialisé.
Y : Réinitialise le code PIN existant du client. Après la réinitialisation, le client devra définir un nouveau code PIN lors de la prochaine visite sur la page du tampon.
N : Conserve le code PIN actuel sans modification.
useYnstring
Default :N
Enum :
YN
Indique si le client a utilisé la récompense du tampon.
Y : Le client a complété tous les tampons et a utilisé une récompense (par exemple, boisson gratuite, réduction, etc.). Après utilisation, le tampon devient inactif et un nouveau doit être émis.
N : La récompense n’a pas encore été utilisée.
domainstring
Default :https://vvd.bz
Domaine du tampon.
Si vide, le domaine par défaut sera utilisé.
Disponible à partir du plan Premium — vous pouvez définir un domaine personnalisé enregistré dans la section Gestion des Domaines de Liens.
strtYmddate
Date de début de validité du tampon. Exemple : 2025-01-01
endYmddate
Date d’expiration du tampon. Exemple : 2025-12-31
La date d’expiration peut être définie jusqu’à 5 ans à compter d’aujourd’hui.
activeYnstring
Default :Y
Enum :
YN
Indique si le tampon est actif. Si désactivé, le client ne pourra pas utiliser le tampon.
memostring
Note interne à des fins de référence.
userIdstring
ID utilisateur. Utilisé pour gérer le destinataire du tampon.
En général, saisissez l’identifiant de connexion du membre du site web.
Si non défini, un ID utilisateur sera 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. 
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

codeinteger
Code de réponse : 0 = Succès, autres valeurs = Erreur
messagestring
Message de réponse. Si le code n’est pas 0, un message d’erreur est renvoyé.
resultnull