주 콘텐츠로 건너뛰기

4-3. 템플릿 변수 & 혜택 관련

svc biz
  • 업데이트 시간

< 목 차 >

4-1. 템플릿 관리

4.1.1. 템플릿 카테고리 유형

4.1.2. 템플릿 상태값

4.1.3 테이블 템플릿

   

4-2. 혜택 템플릿

 

4-3. 템플릿 변수 & 혜택 관련

=========================================

 

[4.3 템플릿변수(VARIABLE)]

기본형과 LMS 형은 변수(#{변수명})를 지정할 수 있습니다. 변수는 샵(#)과 중괄호{ } 를 활용하여 정의하며, 알파벳, 숫자, 한글, 슬래시(/), 하이픈(-), 언더바(_), _틸드(~)만 허용됩니다. 변수에 치환될 문자열의 글자수 제한은 없습니다.

 

상세

- 혜택 > 기본형, LMS 형 > 자유 변수 사용 가능, 앱 링크 지원

- "searchResultExposure" 여부에 따라 개인화 변수, 버튼링크(앱링크지원) 사용이 가능하게 됩니다.

- searchResultExposure : true 인 경우 #{} 를 사용한 개인화변수를 등록하려고 하면 등록실패가 발생합니다.

- searchResultExposure : false 인 경우 #{} 인 개인화 변수를 정보성 알림과 같이 타이틀과 혜택 > 기본형, LMS 형의 본문에서 사용할 수 있습니다.


1) 등록 예제
{
…
"categoryCode": "B002", 
"templateType": "BENEFIT", 
"productCode": "BENEFIT",
"text": "#{userName}님 주문완료! #{menuName} 주문감사합니다. 이 혜택은 어떠세요?",
"benefit":{
"title":"#{menuName} 주문완료, 이 혜택은 어떠세요?", 
"feedDisplayImageHashId":
"KgDJVEmnIS2tAbbnxVSlp57Vqj2Nmdr8KJu_lEO2bdGjRDChCRtdvvBjJmzVtXyT", 
"feedDisplayEndedAt": "2024-06-24",
"categoryType": "LIVING", 
"benefitTypes":[
"EVENT"
],
"validityInfo":{ "validType":"PERIOD", 
"validStartedAt":"2024-06-13", 
"validEndedAt":"2024-06-24"
},
"searchResultExposure":false, 
"blockCallNumber":"080-123-1234"
},
"buttons": [
{
"type": "WEB_LINK",
"buttonCode": "test1", 
"buttonName": "혜택링크" 
}, 
{ 
"type": "APP_LINK", 
"buttonCode": "test2", 
"buttonName": "혜택앱링크" 
} 
] 
}

 

 

혜택(BENEFIT)

혜택(benefit)의 속성은 다음과 같습니다.

키 타입 설명
categoryType text 카테고리는 피드에서 사업자 이는 유형에 속하는지 의미합니다. 아래 참조.
benefitTypes list 혜택되는 혜택의 유형을 선택합니다. 최소 1 개가 선택되어야 하며 최대 2 개까지 선택 가능합니다. LMS 형의 경우 EVENT 타입으로 고정되며 동종사 입력내 필수가 없습니다.
feedDisplayEndedAt text YYYY-MM-DD 형태의 피드 표시용 만료일입니다. 최대 2 주까지 가능합니다.
feedDisplayImageHashId text

피드에 노출될 피드 이미지의 해시 아이디를 입력합니다. 피드에 노출되는 이미지는 반드시 해상도 598X398 인 이미지를 사용하여야 하며, 그 이외의 해상도는 오류처리됩니다.

이미지 업로드 api 사용시 imageType 을 "feed"로 설정하여 업로드합니다.
title text 혜택 제목을 입력합니다. 피드에 최대 2줄이 노출되며, 혜택명은 센터 1 줄입니다. 한글 기준 20 자 이내를 추천합니다. 기기에 해상도에 따라 노출되는 글자수가 다르며, 말줄임표로 표시됩니다.
discountInfo json 혜택소개 입력 내용을 입력합니다. 추가되는 혜택 유형에 따라 화부 내용의 필수여부가 다릅니다.
validityInfo json 설제 구현이나 적립금과 같은 혜택 정보가 일정시간 동안도 혜택이 유효지간 정보를 입력해야 합니다.

 

 

템플릿 카테고리 '소식(B005)' 선택시 아래 파라미터(키)는 사용이 불가합니다.

  키 항목
1 categoryType 혜택 카테고리
2 benefitTypes 혜택 타입
3 discountInfo 쿠폰 타입
4 feedDisplayEndedAt 노출 지면 일자
5 feedDisplayImageHashId 혜택 탭 노출 이미지
6 validityInfo 혜택 유효 기간

 

 

혜택 카테고리(CATEGORYTYPE)

혜택 카테고리(categoryType)는 다음과 같은 유형이 있습니다. 메세지 카테고리는 해당 메시지가 혜택 탭에 노출될 때 메세지와 함께 노출되며, [인기] 탭 카테고리별 분류에 활용됩니다.

키 설명
FASHION 패션
BEAUTY 뷰티
DIGITAL_APPLIANCE 디지털&가전
LIVING 리빙
FOOD 식품
KIDS 출산&육아
SPORTS_LEISURE 스포츠&레저
NECESSITIES 생활용품
BOOK_HOBBY 도서&취미
FINANCE 금융
ETC 기타

 

 

혜택 유형(BENEFITTYPES)

혜택 유형(benefitTypes)은 다음과 같습니다.

혜택 유형이 있으면 메세지가 혜택 탭에 함께 노출되며, 최대 2 개가 입력될 수 있습니다.

키 설명 혜택소재 첨부 필수여부
TIMESALE 타임 세일 N
GIFT 사은품 증정 N
BONUS 1+1 N
BRANDDAY 브랜드 데이 N
EVENT 이벤트 N
PRODUCT 상품 할인 Y
DELIVERY 배송비 할인 Y
ORDER 장바구니 할인 Y
POINT 적립 Y

 

 

혜택 소재(DISCOUNTINFO)

혜택 소재(discountInfo)는 다음과 같습니다.

키 타입 설명
discountType text 할인유형 - AMOUNT(할인금액 쿠폰), RATE(할인률 쿠폰), POINT(적립금)
discountAmount number 할인금액, discountType 이 AMOUNT 일 때 금액을 숫자로 입력한다.
discountRate number 할인률, discountType 이 RATE 일 때 비율을 숫자로 입력한다.
maxDiscountAmount number 최대 할인금액, discountType 이 RATE 일 때 최대 할인되는 가격을 숫자로 입력한다.
minimumOrderAmount number

최소 주문금액, benefitType 이 POINT

이거나 benefitType 이 PRODUCT, DELIVERY, ORDER 를 포함하고 있으면 1,000 원 이상으로 입력해야 한다.
accumulateAmount number 적립금액, discountType 이 POINT 일 때 적립금액을 숫자로 입력한다.
landingPageUrl text

톡톡 말풍선에서 혜택(쿠폰, 적립금) 부분을 클릭/터치 했을 때 이동할 페이지로 benefitType 이 POINT, PRODUCT, DELIVERY, ORDER 를 포함할 때

반드시 입력해야 한다.

 

 

유효기간(VALIDITYINFO)

유효기간(validityInfo) 정보는 다음과 같습니다.

키 설명
validType 혜택유효 유형 - PERIOD(기간으로 설정), EXPIRATION(발급일 기준 설정)
validDays EXPIRATION 유효 유형인 경우로 다운로드 후 N 일간 유효하다는 의미
validStartedAt PERIOD 유효 유형인 경우로 유효기간 시작일이다. YYYY-MM-DD 형태이다.
validEndedAt PERIOD 유효 유형인 경우로 유혀기간 종료일이다. YYYY-MM-DD 형태이다.

 

템플릿 카테고리 (소식 카테고리) 

- 혜택 > 템플릿 카테고리 '소식'일 경우, 혜택탭과 관련된 혜택 카테고리, 타입, 유효기간, 노출이미지, 노출지면 종료일자 파라미터가 들어갈 경우, 등록 실패가 됩니다. 
- searchResultExposure 는 항상 false 로 고정됩니다.
분류 코드
쿠폰 B001
적립금 B002
추가 증정 B003
기타 이벤트 B004
소식 B005

 

기타속성

 키  타입 설명
blockCallNumber text

 080 으로 시작하는 광고수신거부 전화번호를 입력합니다. 형태는 080-123-1234 입니다.

blockCallNumber 나 blockMessageUrl 을 둘 중 하나 반드시 입력해야 합니다.
blockMessageUrl text

 https 로 시작하는 광고수신거부 url 을 입력합니다. 형태는 https://도메인 입니다.

blockCallNumber 나 blockMessageUrl 을 둘 중 하나 반드시 입력해야 합니다.
searchResultExposure boolean

 검색결과에 노출여부를 설정하는 값입니다. 미입력시

'false'가 기본값으로 입력됩니다.

Example] [Request- 광고성-BASIC]
   

curl -L -X POST 'https://napi.bizppurio.com/v1/template/register/benefit' \

-H 'Content-Type: application/json' \

-H 'Accept: application/json' \

-H ‘Authorization: Bearer {{accessToken}}' \

-d '{

"naverPartnerKey": "{{naverPartnerKey}}", "productCode": "BENEFIT", "templateType": "BENEFIT",

"templateCode": "TP-BENEFIT-BASIC-20241230-160245",

"categoryCode": "B002",

"text": "역대급 할인 오늘 단 하루만 진행! 패션 PICK 5 시간 후 종료! 20 시까지 오늘 출발 상품", "sampleImageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "buttons": [

{

"type": "WEB_LINK",

"buttonName": "구매하기", "buttonCode": "POPUP_BUTTON1", "mobileUrl": "https://m.naver.com", "pcUrl": "https://www.naver.com"

},

{

"type": "WEB_LINK",

"buttonName": "팝업스토어", "buttonCode": "POPUP_BUTTON2", "mobileUrl": "https://m.naver.com", "pcUrl": "https://www.naver.com"

}

],

"benefit": {

"title": "곧 종료 시즌 막바지 ~70% 대박할인!",

"feedDisplayImageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "feedDisplayEndedAt": "2024-12-30",

"categoryType": "LIVING", "benefitTypes": [

"TIMESALE", "PRODUCT"

],

"discountInfo": {

"discountType": "AMOUNT", "discountAmount": 3000,

"minimumOrderAmount": 10000, "landingPageUrl": "https://www.naver.com"

},

"validityInfo": {

"validType": "PERIOD", "validStartedAt": "2024-12-30",

"validEndedAt": "2024-12-30"

},

"blockCallNumber": "080-123-1234"

}

}'

  

 

 

 

 

 

 

 

 

 

 

 

 

 

 
[Example] [Request- 광고성-LMS]
 

curl -L -X POST 'https://napi.bizppurio.com/v1/template/register/benefit' \

-H 'Content-Type: application/json' \

-H 'Accept: application/json' \

-H ‘Authorization: Bearer {{accessToken}}' \

-d '{

"naverPartnerKey": "{{naverPartnerKey}}", "productCode": "BENEFIT", "templateType": "BENEFIT_LMS",

"templateCode": "TP-BENEFIT-LMS-20241230-160245",

"categoryCode": "B002",

"text": "안녕하세요, 고객님.\n 진화하는 신종 보이스 피싱, 스미싱(피싱)은 예방이 최우선입니다!\n\n▶ 보이스 피싱, 스미싱 피해 않기 \n③ 택배 배송 조회 등의 명목으로 본인인증, 신분증 및 개인정보, 금융정보를 요구하는 경우 절대 입력하지 않고 알려주지 기능 설정하기 \n⑦ 악성 앱 감염이 의심되거나 개인정보 유출이 의심되면 신속히 경찰(신고전화 112)에 전화하여 신고하기\n\n 그 명의도용방지서비스 홈페이지를 통해 가입 및 모바일 애플리케이션 중 ‘PASS 앱’을 통해 가입하기\n\n▶ 금융권 사칭 및 국세청, 관 문의.상담/문의:02-5-71**’\n '\''페이 01/05 985,000 원 결제완료(무이자 3 개월)귀하사용아니시면 (18-61**)취소요청’\n'\''고객님[관세납부 사례\n'\''부고, 부친께서 26 일 저녁 운명하셨기에 문자로 알려드리는 바입니다’\n'\''[부고] 모친께서 별세하셨습니다 침울한 심정으로 교통사고로 돌아가셨기에 삼가알려드립니다. 장례식장'\'' 문자와 함께 URL 링크 주소 첨부하는 부고 문자 사칭 \n\n▶ 건강보험공단 전송완'\''료.내용보기’ 라는 문자와 함께 URL 링크 주소 첨부\n\n▶ 문의\n· 모바일 고객센터 114(무료)\n",

"benefit": {

"title": "1 월 특판 잔여 물량 선착순, 181 일 세전 금리 5%, 연금 보험, 올해가 마지막 기회!", "feedDisplayImageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "feedDisplayEndedAt": "2024-12-30",

"categoryType": "FINANCE", "benefitTypes": [

"EVENT"

],

"validityInfo": {

"validType": "PERIOD", "validStartedAt": "2024-12-30",

"validEndedAt": "2024-12-30"

},

"blockCallNumber": "080-123-1234"

}

}'
[Example] [Request- 광고성-BENEFIT_CAROUSEL_COMMERCE]
 

curl -L -X POST 'https://napi.bizppurio.com/v1/template/register/benefit' \

-H 'Content-Type: application/json' \

-H 'Accept: application/json' \

-H ‘Authorization: Bearer {{accessToken}}' \
[Example] [Request- 광고성-BENEFIT_LIST_COMMERCE]
 

curl -L -X POST 'https://napi.bizppurio.com/v1/template/register/benefit' \

-H 'Content-Type: application/json' \

-H 'Accept: application/json' \

-H ‘Authorization: Bearer {{accessToken}}' \

-d '{

"naverPartnerKey": "{{naverPartnerKey}}",

"templateCode": "TP-BENEFIT-LIST-COMMERCE-20241230-160245",

"productCode": "BENEFIT",

"templateType": "BENEFIT_LIST_COMMERCE", "categoryCode": "B002",

"benefit": {

"feedDisplayImageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "feedDisplayEndedAt": "2024-12-25",

"categoryType": "FASHION", "benefitTypes": [

"TIMESALE", "PRODUCT"

],

"discountInfo": {

"discountType": "AMOUNT", "discountAmount": 3000,

"minimumOrderAmount": 10000, "landingPageUrl": "https://www.naver.com"

},

"validityInfo": {

"validType": "PERIOD", "validStartedAt": "2024-12-25",

"validEndedAt": "2024-12-26"

},

"searchResultExposure": true, "introduction": {

"headerImageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "title": "지금부터 아뜨랑스 시즌🎵 예뿜뿜!!",

 

"buttonTitle": "바로가기", "mobileUrl": "https://m.naver.com", "pcUrl": "https://www.naver.com"

},

"products": [

{

"imageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "title": "가을꽈배기니트 가디건",

"originalPrice": "127000",

"currentPrice": "69000", "buttonType" :"WEB_LINK", "mobileUrl": "https://m.naver.com", "pcUrl": "https://www.naver.com"

},

{

"imageUrl": "https://...resize-image-1.jpg",

"title": "가을 신상 바지", "originalPrice": "78000", "buttonType" :"WEB_LINK", "mobileUrl": "https://m.naver.com", "pcUrl": "https://www.naver.com"

},

{

 

"title": "가을 신상 2", "originalPrice": "28000", "buttonType" :"WEB_LINK", "mobileUrl": "https://m.naver.com", "pcUrl": "https://www.naver.com"

}

],

"blockCallNumber": "080-123-1234"

}

}'
[Example] [Request- 광고성-BENEFIT_CAROUSEL_FEED]
 

curl -L -X POST 'https://napi.bizppurio.com/v1/template/register/benefit' \

-H 'Content-Type: application/json' \

-H 'Accept: application/json' \

-H ‘Authorization: Bearer {{accessToken}}' \

-d '{

"naverPartnerKey": "{{naverPartnerKey}}",

"templateCode": "TP-BENEFIT-CAROUSEL-FEED-20241230-160245",

"productCode": "BENEFIT",

"templateType": "BENEFIT_CAROUSEL_FEED", "categoryCode": "B004",

"benefit": {

"searchResultExposure" : "true",

"feedDisplayImageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "feedDisplayEndedAt": "2024-12-30",

"categoryType": "FASHION", "benefitTypes": [

"EVENT"

],

"validityInfo": {

"validType": "PERIOD", "validStartedAt": "2024-12-30",

"validEndedAt": "2024-12-30"

},

"moreButtonType": "APP_LINK", "moreButtonUrl": "https://www.naver.com",

"moreButtonMobileUrl": "https://www.naver.com", "products": [

{

"imageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "title": "가을꽈배기니트 가디건",

"description": "다가오는 가을, 특별한 아웃핏으로 시원하고 멋진 가을 보내세요😀\n 역대급 할인 오늘 단 하루만 진"

"buttons": [

{

"type": "WEB_LINK",

"buttonName": "구매하기", "mobileUrl": "https://m.naver.com", "pcUrl": "https://www.naver.com"

},

{

"type": "WEB_LINK",

"buttonName": "팝업스토어가나다", "mobileUrl": "https://m.naver.com", "pcUrl": "https://www.naver.com"

}

]

},

{

"imageUrl": "https://...resize-image-1.jpg", "title": "가을 신상 바지",

"description": "다가오는 가을,", "buttons": [

{

"type": "APP_LINK",

"buttonName": "구매하기", "iOsAppScheme": "https://naver.com", "aOsAppScheme": "https://m.naver.com"

}

]

}

],

"blockCallNumber": "080-123-1234"

}

}'
[Example] [Request- 광고성-BENEFIT_LIST_FEED]

curl -L -X POST 'https://napi.bizppurio.com/v1/template/register/benefit' \

-H 'Content-Type: application/json' \

-H 'Accept: application/json' \

-H ‘Authorization: Bearer {{accessToken}}' \

-d '{

"naverPartnerKey": "{{naverPartnerKey}}",

"templateCode": "TP-BENEFIT-LIST-FEED-20241230-160245",

"productCode": "BENEFIT", "templateType": "BENEFIT_LIST_FEED", "categoryCode": "B002",

"benefit": {

"feedDisplayImageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "feedDisplayEndedAt": "2024-12-30",

"categoryType": "FASHION", "benefitTypes": [

"TIMESALE",

"PRODUCT"

],

"discountInfo": {

"discountType": "AMOUNT", "discountAmount": 3000,

"minimumOrderAmount": 10000, "landingPageUrl": "https://www.naver.com"

},

"validityInfo": {

"validType": "PERIOD", "validStartedAt": "2024-12-30",

"validEndedAt": "2024-12-30"

},

"searchResultExposure": true, "introduction": {

"headerImageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "title": "지금부터 아뜨랑스 시즌🎵 예뿜뿜!!",

 

"buttonTitle": "바로가기", "mobileUrl": "https://m.naver.com", "pcUrl": "https://www.naver.com"

},

"products": [

{

"imageUrl": "https://...resize-image-1.jpg", "title": "가을꽈배기니트 가디건", "buttonType" :"WEB_LINK",

"mobileUrl": "https://m.naver.com", "pcUrl": "https://www.naver.com"

},

{

"imageUrl": "https://...resize-image-1.jpg", "title": "가을 신상 바지",

"buttonType" :"WEB_LINK", "mobileUrl": "https://m.naver.com", "pcUrl": "https://www.naver.com"

},

{

"imageUrl": "https://...resize-image-1.jpg", "title": "가을 신상 코트",

"buttonType" :"WEB_LINK", "mobileUrl": "https://m.naver.com", "pcUrl": "https://www.naver.com"

}

],

"blockCallNumber": "080-123-1234"

}

}'

  

 

 

[Response]

템플릿 상세 조회 참고

 

POST /v1/template/modify                                                   

템플릿 수정 (modifyTemplate)

템플릿 수정 :

템플릿을 등록한 뒤 수정해🅓 하거나, 템플릿 심사가 반려되면 API 를 통해 수정이 가능합니다. 수정된 템플릿은 등록(REGISTERED)상태로 업데이트됩니다.

 

buttons 의 경우 버튼을 모두 제거하려면 빈 배열([])을 넣어서 요청하시면 됩니다.

 

수정이 필요한 필드만 요청하여 수정할 수 있습니다.

"productCode", "templateCode", "naverPartnerKey", "templateType", "createdAt", "modifiedAt" 필드는 변경할 수 없습니다. 그 외의 필드는 변경할 수 있습니다.

** 정보성기본형/혜택/테이블형의 buttons, couponDescription 같은 목록형 데이터는 입력값 전체를 기존값과 교체합니다.

 

# 배열형태의 데이터 수정(테이블형, 혜택 캐러셀/리스트)

각 항목별로 "updateMode" 를 사용하여 삭제, 수정, 추가를 진행합니다. updateMode 는 소문자로 입력하며 다음과 같습니다.

  • delete : 해당 순서에 항목을 삭제합니다.
  • update : 해당 순서의 항목에 입력된 필드를 수정합니다. 일반 수정처럼 필요항목만 입력 가능합니다.
  • add : 입력한 페이로드를 이용하여 목록의 마지막에 항목을 추가합니다.

-H 'Content-Type: application/json'

-H 'Authorization: Bearer {{accessToken}}'

 

상세 파라미터 정보는 템플릿 등록/조회 참고

[Example] [Request]
 

curl -L -X POST 'https://napi.bizppurio.com/v1/template/modify \

-H 'Content-Type: application/json' \

-H 'Accept: application/json' \

-H ‘Authorization: Bearer {{accessToken}}' \

-d '{

"naverPartnerKey": "{{naverPartnerKey}}", "productCode": "INFORMATION",

"templateCode": "TP-INFORMATION-BASIC-20241119-80",

"text": "템플릿 수정 테스트입니다.", "categoryCode": "S001", "templateType": "BASIC",

"buttons" : []

}'

  
[Example] [Response]

{

"code": "200",

"message": "요청 성공", "data": {

"id": "3103",

"templateType": "BASIC", "productCode": "INFORMATION",

"code": "TP-INFORMATION-BASIC-20241119-80",

"text": "템플릿 수정 테스트입니다.", "partnerId": "{{naverPartnerId}}", "categoryCode": "S001", "templateStatusType": "APPROVED", "templateSendingStatusType": "WAITING", "freeOfCharge": false,

"createdAt": "2024-11-19 16:39:25",

"modifiedAt": "2024-12-30 16:40:05"

}

}

  



POST /v1/template/inspect                                                  

템플릿 검수 요청 (inspectTemplate)

템플릿 검수 요청

-H 'Content-Type: application/json'

-H 'Authorization: Bearer {{accessToken}}'

요청 파라미터
키 - 타입 필수 설명
naverPartnerKey   String O 파트너 키
templateCode   String O 템플릿 코드
comment   String X 내용
반환 값
키 - 타입 설명
code   String 결과 코드
message   String 실패 시 결과 메시지
data   Object 성공 시 데이터
templateCode   String 템플릿 코드
[Example] [Request]
 

{

 

 

 

 

}

 

"naverPartnerKey":"{{naverPartnerKey}}", "templateCode":"TP-INFORMATION-TABLE-20241113-78",

"comment": "검수 요청"

  
[Example] [Response]
  {    
    "code": "200",  
    "message": "요청 성공",  
    "data": {  
    "templateCode": "TP-INFORMATION-TABLE-20241113-78",  
    }  
  }    



POST /v1/template/inspect/cancel                                           

템플릿 검수 요청 취소 (inspectCancelTemplate)

템플릿 검수 요청 취소

-H 'Content-Type: application/json'

-H 'Authorization: Bearer {{accessToken}}'

요청 파라미터
키 - 타입 필수 설명
naverPartnerKey   String O 파트너 키
templateCode   String O 템플릿 코드
comment   String X 내용
반환 값
키 - 타입 설명
code   String 결과 코드
message   String 실패 시 결과 메시지
[Example] [Request]
  {      
  "naverPartnerKey":"{{naverPartnerKey}}",
  "templateCode":"TP-INFORMATION-TABLE-20241113-78",
  "comment": "검수 요청 취소"
}  
[Example] [Response]
  {        
  "code": "200",
  "message": "요청 성공"
}  

 

POST /v1/template/inspect/history                                          

템플릿 검수 요청 이력 (inspectHistoryTemplate)

템플릿 검수 요청 이력

-H 'Content-Type: application/json'

-H 'Authorization: Bearer {{accessToken}}'

요청 파라미터
키 - 타입 필수 설명
naverPartnerKey   String O 파트너 키
templateCode   String O 템플릿 코드
comment   String X 내용
반환 값
키 - 타입 설명
code   String 결과 코드
message   String 실패 시 결과 메시지
data   Array 성공 시 데이터
  content String 내용
  createdAt Date 생성시점
[Example] [Request]
  {        
  "naverPartnerKey":"{{naverPartnerKey}}",
  "templateCode":"TP-INFORMATION-TABLE-20241113-78"
}  
[Example] [Response]
  {

 

"code": "200",

"message": "요청 성공", "data": [

{

"content": "검수 요청", "createdAt": "2024-12-26 15:40:39"

},

{

"content": "취소",

"createdAt": "2024-12-26 15:41:06"

}

]

      

 

 

 

 

 

 

 

}

 

POST /v1/template/remove                                                   

템플릿 삭제 (removeTemplate)

 

템플릿 삭제

-H 'Content-Type: application/json'

-H 'Authorization: Bearer {{accessToken}}'

요청 파라미터
키 - 타입 필수 설명
naverPartnerKey   String O 파트너 키
templateCode   String O 템플릿 코드
반환 값
키 - 타입 설명
code   String 결과 코드
message   String 실패 시 결과 메시지
data   Object 성공 시 데이터
  templateCode String 템플릿 코드
[Example] [Request]
  {      
  "naverPartnerKey":"{{naverPartnerKey}}",
  "templateCode":"TP-INFORMATION-IMAGE-20241226-4200"
}  
[Example] [Response]
  {      
  "code": "200",
  "message": "요청 성공",
  "data": {
  "templateCode": "TP-INFORMATION-IMAGE-20241226-4200"
  }
}  

 

POST /v1/template/search                                                   

최근 변경된 템플릿 조회 (searchTemplate)

-H 'Content-Type: application/json'

-H 'Authorization: Bearer {{accessToken}}'

키 타입 필수 설명 예제
naverPartnerKey Text(64) Y 파트너 키  
fromDate text(8) Y

수정일 조회를 시작할 일자를

8 자리로 입력해야 합니다.

 yyyyMMdd (20240901)
toDate text(8) N 수정일 조회를 완료할 일자를 8 자리로 입력해야 합니다. 미입력시 현재일자로 조회됩니다. yyyyMMdd (현재일자)
page number N 조회할 페이지 수를 입력합니다. 미입력시 디폴트 값은 1 입니다.

페이지 숫자 값

(디폴트:1)
count number N 조회할 페이지의 크기를 입력합니다. 미입력시 디폴트 값은 30 입니다. 페이지의 크기 값 (디폴트:30)
modifiedOnly boolean N

수정된 값만 조회할지 여부를 입력합니다. 미입력시 디폴트 값은 true 입니다. false 를 입력할 경우 수정하지 않은

템플릿도 조회됩니다.

 true / false (디폴트:true)
[Example] [Request]
 

{

"naverPartnerKey":"{{naverPartnerKey}}", "fromDate":"2024-12-25",

"toDate":"2024-12-30",

"page": 1,

"count": 3

}

  
[Example] [Response]
 

{

"code": "200",

"message": "요청 성공",

"data": [

{

"id": "31152",

"code": "test-bizppurio-001",

"partnerId": "w3z4sl",

"freeOfCharge": false,

"createdAt": "2024-12-20 13:32:42",

"modifiedAt": "2024-12-26 16:38:51"

},

{

"id": "31199",

"code": "test-daou-001",

"partnerId": "w1z2sl",

"freeOfCharge": false,

"createdAt": "2024-12-26 18:03:55",

"modifiedAt": "2024-12-26 18:10:07" 

}

]

}

  

 

관련 문서

댓글

댓글 0개

이 문서에는 댓글을 달 수 없습니다.