Site Display Mall

Retrieve Site

get

Function Description

This API retrieves a single site information record.

Detailed Description

Retrieves the site information using the site number from the cookie value. (default: 1)

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Retrieve Site Information Success

*/*

Site Information DTO

siteNostringOptional

Site No.

Example: 1

siteNmstringOptional

Site Name

Example: x2bee

trdStrtDtstringOptional

Transaction Start Date

Example: 2021-01-01

trdEndDtstringOptional

Transaction End Date

Example: 2029-12-31

siteDomstringOptional

Site Domain

Example: x2bee.com

400

Retrieve Site Information Failure

*/*

get/v1/site

GET /api/display/v1/site HTTP/1.1
Host: api-display.x2bee.com/
Accept: */*

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

Retrieve Site Popup List

get

Function Description

This API retrieves the list of popup information for the site.

Detailed Description

If the channel detail number is not entered, the default value 1000001 is set.
Only popups within the popup period are displayed, shown in order of priority.
- If priorities are equal, they are displayed in order of system registration, then system modification.

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

Popup list information retrieved successfully

*/*

Site Popup Information DTO

popupNostringOptional

Popup No.

Example: 141

popupNmstringOptional

Popup Name

Example: 팝업명

popupTypCdstringOptional

Popup Type Code (DP014 01: Information Popup, 02: App Link Popup, 03: Coupon Download Popup)

Example: 01

prtTypCdstringOptional

Popup Output Type Code (DP017 01: Full Screen, 02: Partial Screen)

Example: 02

popupContGbCdstringOptional

Popup Content Type Code (DP029 01: Image Type, 02: HTML)

Example: 01

popupLinkstringOptional

Popup Link

Example: x2bee.com

popupImgPathNmstringOptional

Popup Image Path (Required when display media is MOBILE)

Example: /test

popupContstringOptional

Popup Content (Required when popup content type code is HTML)

Example: 팝업내용

popupSzWdtstringOptional

Popup Size Width (Required when display media is PC)

Example: 10

popupSzHighstringOptional

Popup Size Height (Required when display media is PC)

Example: 20

popupLocLeftstringOptional

Popup Position LEFT (Required when display media is PC)

Example: 30

popupLocTopstringOptional

Popup Position (Required when display media is PC)

Example: 40

chlDtlNostringOptional

Channel Detail No.

Example: 1000001

chlLinkInfostringOptional

Channel Link Information (Used as the app tracking code when popup type code is 02, or as the coupon number when 03)

prioRnkstringOptional

Priority

Example: 1

400

Failed to retrieve popup list information

*/*

get/v1/site/popupList

GET /api/display/v1/site/popupList?dispMediaCd=text&popupTgtScrnCd=text&chlDtlNo=text HTTP/1.1
Host: api-display.x2bee.com/
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
}

Retrieve Site Terms List

get

Function Description

This API retrieves the terms information for the site and the list of past terms application dates.

Detailed Description

Retrieves the terms information and the list of past terms application dates as of the current date.
- If two or more terms apply as of the current date, only the one with the most recent application start date is retrieved.
- The list of past terms application dates is displayed in most-recent-first order.

Query parameters

siteNostringRequired

string

Example: 1

agmtPolcCdstringRequired

string

Example: 300

aplyStrDtstringRequired

string

Example: 20230101

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Terms information retrieved successfully

*/*

Terms Information DTO

cmAgmtSeqstringOptional

Common Terms Sequence No.

Example: 10202

siteNostringOptional

Site No.

Example: 1

cmAgmtPolcGbCdstringOptional

Common Terms Type Code (CH010)

Example: 300

agmtPolcCdstringOptional

Terms Policy Code (CH005)

Example: 300

agmtPolcNmstringOptional

Terms & Policy Name

Example: 개인정보처리방침

aplyStrDtstringOptional

Application Start Date

Example: 20230101

aplyEndDtstringOptional

Application End Date

Example: 20231231

titlestringOptional

Title

Example: 약관제목

wrdContstringOptional

Text Content

Example: 약관문구내용

langCdstringOptional

Language Code (CM009)

Example: ko

400

Failed to retrieve terms information

*/*

get/v1/site/policyList

GET /api/display/v1/site/policyList?siteNo=text&agmtPolcCd=text&aplyStrDt=text HTTP/1.1
Host: api-display.x2bee.com/
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
    }
  ]
}

Retrieve Display Mall List

get

Function Description

This API retrieves the list of malls belonging to the site.

Detailed Description

Retrieves the mall information list using the site number from the cookie value. (default: 1)
Mall information is displayed in display order.

Code Summary

Display Status : Y,N

Query parameters

siteNoanyRequired

Site No. (x2bee.com : 1)

Example: 1

dispYnanyRequired

Display Status (Displayed: Y, Not Displayed: N)

Example: Y

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Mall Information Retrieved Successfully

*/*

Mall Information DTO

dpmlNostringOptional

Mall No.

Example: 1

dpmlNmstringOptional

Mall Name

Example: 전시몰명

linkUrlAddrstringOptional

Link URL

Example: http://www.x2bee.com

movFrmeCdstringOptional

Navigation Frame Code (DP007)

Example: 01

dispSeqstringOptional

Display Order

Example: 1

400

Mall Information Retrieval Failed

*/*

get/v1/mall

GET /api/display/v1/mall HTTP/1.1
Host: api-display.x2bee.com/
Accept: */*

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

Retrieve Single Display Mall

get

Function Description

This API retrieves a single mall information record.

Detailed Description

Retrieves the mall information using the mall number.

Code Summary

Mall No. : e.g., 10001

Query parameters

mallNostringRequired

Mall No.

Example: 10001

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Mall Information Retrieved Successfully

*/*

Mall Information DTO

dpmlNostringOptional

Mall No.

Example: 1

dpmlNmstringOptional

Mall Name

Example: 전시몰명

linkUrlAddrstringOptional

Link URL

Example: http://www.x2bee.com

movFrmeCdstringOptional

Navigation Frame Code (DP007)

Example: 01

dispSeqstringOptional

Display Order

Example: 1

400

Mall Information Retrieval Failed

*/*

get/v1/mall/defaultShop

GET /api/display/v1/mall/defaultShop?mallNo=text HTTP/1.1
Host: api-display.x2bee.com/
Accept: */*

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

PreviousBulletin Board

NextDisplay Store

Last updated 1 month ago