Validación de Sello
Esta API se utiliza para verificar si un sello es válido antes de agregar, eliminar sellos o procesar el uso de una recompensa.
La validación se realiza según los siguientes criterios:
- Validez del Stamp IDX
- Período de validez del sello
- Estado de activación del sello
- Si la recompensa ya fue utilizada
Esta API está disponible para planes Personal y superiores.
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
- Código de respuesta: 0 = Éxito, cualquier otro valor = Error
- messagestring
- Mensaje de respuesta. Si el código no es 0, se devuelve un mensaje relacionado con el error.
- resultobject
-
Si la verificación es exitosa, la respuesta incluirá la información del sello.
Si falla, el valor de la respuesta seránully el mensaje de error mostrará la causa. - stampIdx integer
- Stamp IDX.
- domain string
- Dominio del sello.
- cardIdx integer
- Card IDX.
- cardNm string
- Nombre de la tarjeta.
- cardTtl string
- Título de la tarjeta.
- stamps integer
- Número de sellos acumulados hasta el momento.
- maxStamps integer
- Número máximo de sellos permitidos en la tarjeta.
- stampUrl string
- URL de la página del sello.
- url string
- URL a la que se redirige al usuario al hacer clic en el botón dentro de la página del sello.
- strtYmd date
- Fecha de inicio de validez del sello.
- endYmd date
- Fecha de expiración del sello.
- onsiteYn string
-
Enum:
YN
-
Indica si la acumulación en tienda está habilitada.
Si el valor esY, el personal de la tienda puede añadir sellos directamente en el establecimiento. - onsitePwd string
-
Contraseña de acumulación en tienda.
Obligatoria al usar la API de beneficios si la opción en tienda está activada (Y). - memo string
- Nota interna de referencia.
- activeYn string
-
Enum:
YN
-
Indica si el sello está activo.
Si está desactivado, los clientes no podrán usar el sello. - userId string
-
ID del usuario. Se usa para administrar el destinatario del sello.
Normalmente corresponde al ID de inicio de sesión del miembro del sitio web.
Si no se establece, el sistema generará automáticamente un ID de usuario. - userNm string
- Nombre del usuario. Solo para uso interno.
- userPhnno string
- Teléfono del usuario. Solo para uso interno.
- userEml string
- Correo electrónico del usuario. Solo para uso interno.
- userEtc1 string
- Campo adicional para gestión interna.
- userEtc2 string
- Campo adicional para gestión interna.
- stampImgUrl string
- URL de la imagen del sello.
- regYmdt datetime
- Fecha de creación del sello. Ejemplo: 2025-07-21 11:50:20