사이트 전시몰

사이트 조회

get

기능설명

• 사이트 정보 단건을 조회하는 API 입니다.

---

상세설명

• 쿠키값에 사이트번호를 받아 해당 사이트 정보를 조회한다. (default : 1)

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

사이트 정보 조회 성공

*/*

사이트 정보 DTO

siteNostringOptional

사이트번호

Example: 1

siteNmstringOptional

사이트명

Example: x2bee

trdStrtDtstringOptional

거래시작일자

Example: 2021-01-01

trdEndDtstringOptional

거래종료일자

Example: 2029-12-31

siteDomstringOptional

사이트도메인

Example: x2bee.com

400

사이트 정보 조회 실패

*/*

get

/v1/site

HTTPcURLJavaScriptPython

GET /api/display/v1/site HTTP/1.1
Host: localhost:8094/
Accept: */*

{
  "siteNo": 1,
  "siteNm": "x2bee",
  "trdStrtDt": "2021-01-01",
  "trdEndDt": "2029-12-31",
  "siteDom": "x2bee.com"
}

사이트 팝업목록 조회

get

기능설명

• 해당 사이트의 팝업 정보 목록을 조회하는 API 입니다.

---

상세설명

• 채널상세번호를 입력하지 않았을 경우에는 default 1000001이 설정됩니다.

• 팝업 기간에 해당되는 팝업만 노출되고 우선순위 순으로 노출됩니다.

  • 우선순위가 같을경우 시스템 등록순, 시스템 수정순으로 노출됩니다.

Query parameters

dispMediaCdstringRequired

string

Example: 20

popupTgtScrnCdstringRequired

string

Example: 02

dispMediaDtlCdstringOptional

string

Example: ios

chlDtlNostringRequired

string

Example: 1000001

prtTypCdstringOptional

string

Example: 01

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

팝업리스트 정보 조회 성공

*/*

사이트 팝업 정보 DTO

popupNostringOptional

팝업번호

Example: 141

popupNmstringOptional

팝업명

Example: 팝업명

popupTypCdstringOptional

팝업유형코드(DP014 01:정보제공형팝업, 02:앱연결팝업,03:쿠폰다운로드팝업)

Example: 01

prtTypCdstringOptional

팝업출력유형코드(DP017 01:전체화면, 02:일부화면)

Example: 02

popupContGbCdstringOptional

팝업내용구분코드(DP029 01:이미지형, 02:HTML)

Example: 01

popupLinkstringOptional

팝업링크

Example: x2bee.com

popupImgPathNmstringOptional

팝업이미지경로명 (전시매체 MOBILE일 경우 필수)

Example: /test

popupContstringOptional

팝업내용 (팝업내용구분코드 HTML일 경우 필수)

Example: 팝업내용

popupSzWdtstringOptional

팝업사이즈넓이 (전시매체 PC일 경우 필수)

Example: 10

popupSzHighstringOptional

팝업사이즈높이 (전시매체 PC일 경우 필수)

Example: 20

popupLocLeftstringOptional

팝업위치LEFT (전시매체 PC일 경우 필수)

Example: 30

popupLocTopstringOptional

팝업위치 (전시매체 PC일 경우 필수)

Example: 40

chlDtlNostringOptional

채널상세번호

Example: 1000001

chlLinkInfostringOptional

채널연결정보 (팝업유형코드가 02인 경우 앱 트래킹코드, 03인 경우 쿠폰번호로 사용)

prioRnkstringOptional

우선순위

Example: 1

400

팝업리스트 정보 조회 실패

*/*

get

/v1/site/popupList

HTTPcURLJavaScriptPython

GET /api/display/v1/site/popupList?dispMediaCd=text&popupTgtScrnCd=text&chlDtlNo=text HTTP/1.1
Host: localhost:8094/
Accept: */*

{
  "popupNo": 141,
  "popupNm": "팝업명",
  "popupTypCd": "01",
  "prtTypCd": "02",
  "popupContGbCd": "01",
  "popupLink": "x2bee.com",
  "popupImgPathNm": "/test",
  "popupCont": "팝업내용",
  "popupSzWdt": 10,
  "popupSzHigh": 20,
  "popupLocLeft": 30,
  "popupLocTop": 40,
  "chlDtlNo": 1000001,
  "chlLinkInfo": "text",
  "prioRnk": 1
}

사이트 약관 목록 조회

get

기능설명

• 해당 사이트의 약관 정보와 과거 약관적용 날짜 목록을 조회하는 API 입니다.

---

상세설명

• 현재 날짜 기준 해당 약관 정보와 과거 약관 정보 날짜 목록을 조회합니다.

  • 현재 날짜에 적용되는 약관이 2개이상 존재하면 적용 시작날짜가 가장 최근 약관 1건이 조회됩니다.

  • 과거 약관 적용 날짜 목록은 최근순으로 노출됩니다.

Query parameters

siteNostringRequired

string

Example: 1

agmtPolcCdstringRequired

string

Example: 300

aplyStrDtstringRequired

string

Example: 20230101

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

약관 정보 조회 성공

*/*

약관 정보 DTO

cmAgmtSeqstringOptional

공통약관순번

Example: 10202

siteNostringOptional

사이트번호

Example: 1

cmAgmtPolcGbCdstringOptional

공통약관전챙구분코드(CH010)

Example: 300

agmtPolcCdstringOptional

약관정책코드(CH005)

Example: 300

agmtPolcNmstringOptional

약관정책명

Example: 개인정보처리방침

aplyStrDtstringOptional

적용시작일자

Example: 20230101

aplyEndDtstringOptional

적용종료일자

Example: 20231231

titlestringOptional

제목

Example: 약관제목

wrdContstringOptional

문구내용

Example: 약관문구내용

langCdstringOptional

언어코드(CM009)

Example: ko

400

약관 정보 조회 실패

*/*

get

/v1/site/policyList

HTTPcURLJavaScriptPython

GET /api/display/v1/site/policyList?siteNo=text&agmtPolcCd=text&aplyStrDt=text HTTP/1.1
Host: localhost:8094/
Accept: */*

{
  "cmAgmtSeq": 10202,
  "siteNo": 1,
  "cmAgmtPolcGbCd": 300,
  "agmtPolcCd": 300,
  "agmtPolcNm": "개인정보처리방침",
  "aplyStrDt": 20230101,
  "aplyEndDt": 20231231,
  "title": "약관제목",
  "wrdCont": "약관문구내용",
  "langCd": "ko",
  "applyDateList": [
    {
      "cmAgmtSeq": 10202,
      "agmtPolcCd": 300,
      "aplyStrDt": 20230101
    }
  ]
}

전시몰 목록 조회

get

기능설명

• 해당 사이트에 속한 몰 목록을 조회하는 API 입니다.

---

상세설명

• 쿠키값에 사이트번호를 받아 해당 몰 정보 목록을 조회한다. (default : 1)

• 몰 정보는 전시 순서 순으로 노출됩니다.

---

코드정리

• 전시여부 : Y,N

Query parameters

siteNoanyRequired

사이트번호 (x2bee.com : 1)

Example: 1

dispYnanyRequired

전시여부 (전시 : Y, 비전시 : N)

Example: Y

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

몰 정보 조회 성공

*/*

몰 정보 DTO

dpmlNostringOptional

몰번호

Example: 1

dpmlNmstringOptional

몰명

Example: 전시몰명

linkUrlAddrstringOptional

링크URL주소

Example: http://www.x2bee.com

movFrmeCdstringOptional

이동프레임코드(DP007)

Example: 01

dispSeqstringOptional

전시순서

Example: 1

400

몰 정보 조회 실패

*/*

get

/v1/mall

HTTPcURLJavaScriptPython

GET /api/display/v1/mall HTTP/1.1
Host: localhost:8094/
Accept: */*

{
  "dpmlNo": 1,
  "dpmlNm": "전시몰명",
  "linkUrlAddr": "http://www.x2bee.com",
  "movFrmeCd": "01",
  "dispSeq": 1
}

전시몰 단건 조회

get

기능설명

• 몰 정보 단건을 조회하는 API 입니다.

---

상세설명

• 몰 번호를 받아 해당 몰 정보를 조회한다.

---

코드정리

• 몰번호 : ex)10001

Query parameters

mallNostringRequired

몰번호

Example: 10001

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

몰 정보 조회 성공

*/*

몰 정보 DTO

dpmlNostringOptional

몰번호

Example: 1

dpmlNmstringOptional

몰명

Example: 전시몰명

linkUrlAddrstringOptional

링크URL주소

Example: http://www.x2bee.com

movFrmeCdstringOptional

이동프레임코드(DP007)

Example: 01

dispSeqstringOptional

전시순서

Example: 1

400

몰 정보 조회 실패

*/*

get

/v1/mall/defaultShop

HTTPcURLJavaScriptPython

GET /api/display/v1/mall/defaultShop?mallNo=text HTTP/1.1
Host: localhost:8094/
Accept: */*

{
  "dpmlNo": 1,
  "dpmlNm": "전시몰명",
  "linkUrlAddr": "http://www.x2bee.com",
  "movFrmeCd": "01",
  "dispSeq": 1
}