API Guide

쿠폰 조회

  • 쿠폰을 소스라이브 플레이어 화면에 노출합니다.
  • 파트너사의 쿠폰 리스트 API를 소스라이브 플레이어 진입시 요청하여 파트너사의 쿠폰을 조회합니다.
  • AccessToken 정보를 전달 할 경우, 해당하는 _accessToken의 소유 쿠폰의 경우 발급의 유무를 같이 전달해야 합니다.

📘

쿠폰 조회 API는 파트너사에서 제공하며 모비두는 해당 가이드를 따릅니다.

HTTP Request

methodURLDescription
GET-파트너사의 쿠폰 API EndPoint를 제공 받습니다.
POST-파트너사 상품 코드로 제공하는 쿠폰 API EndPoint

Query Parameters

ParameterTypeRequiredDefaultDescription
accessTokenstringfalseNone해당 사용자가 발급 받을 수 있는 쿠폰 리스트 조회, 미 전달 시 전체 쿠폰 리스트 조회
broadcastIdstringfalseNone해당 방송에서 발급 받을 수 있는 쿠폰 리스트 조회

📘

파트너사의 고유 상품 코드로 쿠폰 조회 API로 사용합니다.

Request Body Parameters

ParameterTypeRequiredDefaultDescription
accessTokenstringfalseNone해당 사용자가 발급 받을 수 있는 쿠폰 리스트 조회, 미 전달 시 전체 쿠폰 리스트 조회
externalProductIdsarrayfalseNone상품 등록 시 기입한 파트너사 고유 상품 코드

📘

accessToken 은 회원 연동 시 생성된 JWT Token정보이며 해당 사용자의 쿠폰 발급 유무 확인 및 발급 가능 쿠폰 리스트를 조회 시 사용됩니다.


Response Body

ParameterTypeRequiredDefaultDescription
maxIssueCountnumbertrueNone쿠폰 최대 발급 개수 (0이면 발급 완료)
couponIdstringtrueNone쿠폰의 고유 아이디
couponNamestringtrueNone쿠폰의 이
partnerIdstringtrueNone발급 받은 파트너 id
limitMaxPricenumbertrueNone최대 할인 가능한 금액
dcTypestringtrueNone쿠폰 할인 타입 (할인율=Rate, 할인 금액=Fixed)
dcPricenumbertrueNone할인 금액
dcRatenumbertrueNone할인율 (10%라면 10ㅇ르ㅗ 입력)
possiblePricenumbertrueNone쿠폰을 사용할 수 있는 최소 주문 금액
startDtstringtrueNone쿠폰 사용 시작일
endDtstringtrueNone쿠폰 사용 종료일
isShowbooleantrueNone노출 여

Response Code - 200 : Success

Response Code - 400 : Validation Error

Response Code - 500 : Internal Server Error

📘

쿠폰 형식 데이터는 최대한 위 표에 제시된 Body를 따르며 연동이 필요할 시 협의 하에 추가 개발을 진행해야 합니다.