스템프 검증
이 API는 스템프 도장 추가, 도장 제거, 혜택 사용 처리 전에 스템프가 유효한지 확인하는데 사용됩니다.
다음 기준으로 스템프의 유효성을 검증합니다:
- 스템프 IDX의 유효성
- 스템프 유효기간
- 스템프 활성화 여부
- 이미 혜택이 사용된 스템프 여부
이 API는 퍼스널 요금제 이상에서만 제공됩니다.
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
- 응답 코드: 0 = 성공, 그 외 값 = 오류
- messagestring
- 응답 메시지입니다. 응답 코드가 0이 아니면, 오류 관련 메시지가 반환됩니다.
- resultobject
- 검증에 성공하면 응답값에 스템프 정보가 포함되어 반환됩니다.
검증에 실패하면 응답값은null이며, 오류 메시지를 통해 원인을 확인할 수 있습니다. - stampIdxinteger
- 스템프 IDX.
- domainstring
- 스템프 도메인.
- cardIdxinteger
- 카드 IDX.
- cardNmstring
- 카드 이름.
- cardTtlstring
- 카드 제목.
- stampsinteger
- 현재까지 적립된 도장 수.
- maxStampsinteger
- 카드의 최대 도장 수.
- stampUrlstring
- 스템프 페이지의 URL.
- urlstring
- 스템프 페이지에서 버튼 클릭 시 이동될 URL.
- strtYmddate
- 스템프 유효 시작일.
- endYmddate
- 스템프 유효 만료일.
- onsiteYnstring
- Enum:YN
- 현장 적립 여부로 값이
Y이면, 매장에서 직원이 도장 적립이 가능합니다. - onsitePwdstring
- 현장적립 비밀번호. 현장적립 여부(Y)일 경우, 스템프 혜택 사용 API 호출 시 반드시 필요합니다.
- memostring
- 내부 참고용 메모.
- activeYnstring
- Enum:YN
- 스템프 활성화 여부. 비활성화되면 고객이 스템프를 사용할 수 없습니다.
- userIdstring
- 사용자 ID. 스템프 발급 대상자를 관리하는데 사용됩니다.
일반적으로 웹사이트 회원의 로그인 ID를 입력합니다.
설정되지 않으면 시스템에 의해 자동으로 사용자 ID가 생성됩니다. - userNmstring
- 사용자 이름. 내부 관리용.
- userPhnnostring
- 사용자 연락처. 내부 관리용.
- userEmlstring
- 사용자 이메일. 내부 관리용.
- userEtc1string
- 추가 내부 관리용 필드.
- userEtc2string
- 추가 내부 관리용 필드.
- stampImgUrlstring
- 스템프 도장의 이미지 URL.
- regYmdtdatetime
- 스템프 생성 날짜. 예: 2025-07-21 11:50:20