팝업 정보 관리

팝업 정보 목록 조회

get

기능설명

팝업 정보 목록을 조회하는 API 입니다.

상세설명

팝업기간,사이트번호,전시매체,채널번호/명 의 조회조건에 따라 팝업 정보를 조회합니다.
팝업 정보 목록은 사이트번호,전시시작날짜 오름차순으로 노출됩니다.

수정번호

Release v1.05_231204 : 스프린트5 PO1 결함/개선 - 팝업 조회조건 쿼리 수정

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

siteNostringOptional

사이트번호

Example: 1

dispMediaCdstringOptional

전시매체코드

Example: 20

startDatestringOptional

시작날짜

Example: 20230101

endDatestringOptional

종료날짜

Example: 20991231

chlNostringOptional

채널번호

Example: 1000001

chlNmstringOptional

채널명

Example: 플래티어

rowsPerPagestringRequired

페이지 당 row

Example: 100

pageIdxstringRequired

현재 페이지

Example: 1

Responses

200

팝업 정보 조회 성공

*/*

사이트팝업정보

siteNostringOptional

사이트번호

Example: 1

langCdstringOptional

언어코드

Example: ko

popupNostringOptional

팝업번호

Example: 141

popupNmstringOptional

팝업명

Example: 팝업테스트 명

popupDispStrDtmstring · date-timeOptional

팝업전시시작일시

Example: 2023-01-01 00:00:00.000

popupDispEndDtmstring · date-timeOptional

팝업전시종료일시

Example: 2023-12-31 00:00:00.000

popupTypCdstringOptional

팝업유형코드(DP014)

Example: 01

popupTypCdNmstringOptional

팝업유형코드명(DP014)

Example: 팝업

prioRnkinteger · int32Optional

우선순위

Example: 1

dispMediaCdstringOptional

전시매체코드

Example: 20

popupSzWdtinteger · int32Optional

팝업사이즈넓이

Example: 10

popupSzHighinteger · int32Optional

팝업사이즈높이

Example: 20

popupLocLeftinteger · int32Optional

팝업위치 LEFT

Example: 30

popupLocTopinteger · int32Optional

팝업위치 TOP

Example: 40

prtTypCdstringOptional

출력유형코드(DP017)

Example: 01

popupImgPathNmstringOptional

팝업이미지경로명

Example: /test

popupImgFileNmstringOptional

팝업이미지파일명

Example: 이미지파일명

aosYnstringOptional

AOS 전시여부

Example: N

iosYnstringOptional

IOS 전시여부

Example: N

popupLnkstringOptional

팝업링크

Example: /x2bee.com

popupContstringOptional

팝업내용

Example: 팝업테스트내용

useYnstringOptional

사용여부

Example: Y

popContGbCdstringOptional

팝업내용구분코드(DP029)

Example: 01

chlNostringOptional

채널번호

Example: 1000001

popupTgtScrnListApistring[]Optional

전시코너 API 전달용

Example: [01, 02, 03, 04, 05]

900

팝업 정보 조회 실패

*/*

get/v2/display/sitePopupMgmt

GET /api/bo/v2/display/sitePopupMgmt?rowsPerPage=text&pageIdx=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "siteNo": 1,
  "langCd": "ko",
  "popupNo": 141,
  "popupNm": "팝업테스트 명",
  "popupDispStrDtm": "2023-01-01 00:00:00.000",
  "popupDispEndDtm": "2023-12-31 00:00:00.000",
  "popupTypCd": "01",
  "popupTypCdNm": "팝업",
  "prioRnk": 1,
  "dispMediaCd": 20,
  "popupSzWdt": 10,
  "popupSzHigh": 20,
  "popupLocLeft": 30,
  "popupLocTop": 40,
  "prtTypCd": "01",
  "popupImgPathNm": "/test",
  "popupImgFileNm": "이미지파일명",
  "aosYn": "N",
  "iosYn": "N",
  "popupLnk": "/x2bee.com",
  "popupCont": "팝업테스트내용",
  "useYn": "Y",
  "popContGbCd": "01",
  "chlNo": 1000001,
  "popupTgtScrnListApi": "[01, 02, 03, 04, 05]"
}

팝업 상세내용 등록/수정

post

기능설명

팝업 상세내용을 등록 및 수정하는 API 입니다.

상세설명

전시 매체가 PC일 경우 팝업 위치, 넓이와 HTML를 등록합니다.
전시 매체가 MO일 경우 출력 유형, 이미지형, HTML을 등록합니다.
입력 파라미터( * : 필수)
- 필요 값 : popupNo, popupNm, siteNo, popupDispStrDtm, popupDispEndDtm, popupTypCd, prioRnk, dispMediaCd, popupSzWdt, popupSzHigh, popupLocLeft, popupLocTop , prtTypCd, popupImgPathNm, popupImgFileNm, popupLnk, popupCont, langCd, popContGbCd, popupTgtScrnList, useYn, aosYn, iosYn

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

filestring · binaryOptional

Responses

200

팝업정보 등록 및 수정 성공

*/*

timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

900

팝업정보 등록 및 수정 실패

*/*

post/v2/display/sitePopupMgmt

POST /api/bo/v2/display/sitePopupMgmt HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 962

{
  "file": "binary",
  "prSitePopupInfo": {
    "siteNo": 1,
    "langCd": "ko",
    "popupNo": 141,
    "popupNm": "팝업테스트 명",
    "popupDispStrDtm": "2023-01-01 00:00:00.000",
    "popupDispEndDtm": "2023-12-31 00:00:00.000",
    "popupTypCd": "01",
    "popupTypCdNm": "팝업",
    "prioRnk": 1,
    "dispMediaCd": 20,
    "popupSzWdt": 10,
    "popupSzHigh": 20,
    "popupLocLeft": 30,
    "popupLocTop": 40,
    "prtTypCd": "01",
    "popupImgPathNm": "/test",
    "popupImgFileNm": "이미지파일명",
    "aosYn": "N",
    "iosYn": "N",
    "popupLnk": "/x2bee.com",
    "popupCont": "팝업테스트내용",
    "useYn": "Y",
    "popContGbCd": "01",
    "chlNo": 1000001,
    "popupTgtScrnListApi": "[01, 02, 03, 04, 05]"
  },
  "prSitePopupChlAplyInfoList": {
    "all": [
      {
        "popupNo": 141,
        "chlNo": 1000001,
        "chlNm": "플래티어",
        "linkInfo": "/x2bee"
      }
    ],
    "create": [
      {
        "popupNo": 141,
        "chlNo": 1000001,
        "chlNm": "플래티어",
        "linkInfo": "/x2bee"
      }
    ],
    "update": [
      {
        "popupNo": 141,
        "chlNo": 1000001,
        "chlNm": "플래티어",
        "linkInfo": "/x2bee"
      }
    ],
    "delete": [
      {
        "popupNo": 141,
        "chlNo": 1000001,
        "chlNm": "플래티어",
        "linkInfo": "/x2bee"
      }
    ]
  }
}

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

팝업 관리 목록 삭제

delete

기능설명

팝업 정보를 삭제하는 API 입니다.

상세설명

팝업번호를 입력받아 해당 팝업정보를 삭제합니다.
팝업번호는 필수값입니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject · PrSitePopupInfo[]

사이트팝업정보

siteNostringOptional

사이트번호

Example: 1

langCdstringOptional

언어코드

Example: ko

popupNostringOptional

팝업번호

Example: 141

popupNmstringOptional

팝업명

Example: 팝업테스트 명

popupDispStrDtmstring · date-timeOptional

팝업전시시작일시

Example: 2023-01-01 00:00:00.000

popupDispEndDtmstring · date-timeOptional

팝업전시종료일시

Example: 2023-12-31 00:00:00.000

popupTypCdstringOptional

팝업유형코드(DP014)

Example: 01

popupTypCdNmstringOptional

팝업유형코드명(DP014)

Example: 팝업

prioRnkinteger · int32Optional

우선순위

Example: 1

dispMediaCdstringOptional

전시매체코드

Example: 20

popupSzWdtinteger · int32Optional

팝업사이즈넓이

Example: 10

popupSzHighinteger · int32Optional

팝업사이즈높이

Example: 20

popupLocLeftinteger · int32Optional

팝업위치 LEFT

Example: 30

popupLocTopinteger · int32Optional

팝업위치 TOP

Example: 40

prtTypCdstringOptional

출력유형코드(DP017)

Example: 01

popupImgPathNmstringOptional

팝업이미지경로명

Example: /test

popupImgFileNmstringOptional

팝업이미지파일명

Example: 이미지파일명

aosYnstringOptional

AOS 전시여부

Example: N

iosYnstringOptional

IOS 전시여부

Example: N

popupLnkstringOptional

팝업링크

Example: /x2bee.com

popupContstringOptional

팝업내용

Example: 팝업테스트내용

useYnstringOptional

사용여부

Example: Y

popContGbCdstringOptional

팝업내용구분코드(DP029)

Example: 01

chlNostringOptional

채널번호

Example: 1000001

popupTgtScrnListApistring[]Optional

전시코너 API 전달용

Example: [01, 02, 03, 04, 05]

Responses

200

팝업 정보 삭제 성공

*/*

timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

900

팝업 정보 삭제 실패

*/*

delete/v2/display/sitePopupMgmt

DELETE /api/bo/v2/display/sitePopupMgmt HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 556

[
  {
    "siteNo": 1,
    "langCd": "ko",
    "popupNo": 141,
    "popupNm": "팝업테스트 명",
    "popupDispStrDtm": "2023-01-01 00:00:00.000",
    "popupDispEndDtm": "2023-12-31 00:00:00.000",
    "popupTypCd": "01",
    "popupTypCdNm": "팝업",
    "prioRnk": 1,
    "dispMediaCd": 20,
    "popupSzWdt": 10,
    "popupSzHigh": 20,
    "popupLocLeft": 30,
    "popupLocTop": 40,
    "prtTypCd": "01",
    "popupImgPathNm": "/test",
    "popupImgFileNm": "이미지파일명",
    "aosYn": "N",
    "iosYn": "N",
    "popupLnk": "/x2bee.com",
    "popupCont": "팝업테스트내용",
    "useYn": "Y",
    "popContGbCd": "01",
    "chlNo": 1000001,
    "popupTgtScrnListApi": "[01, 02, 03, 04, 05]"
  }
]

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

팝업 다국어 내용 등록/수정

post

기능설명

팝업 다국어 내용을 등록 및 수정하는 API 입니다.

상세설명

팝업 내용이 HTML 경우 다국어 HTML, 이미지일 경우 다국어 이미지를 등록한다.
입력 파라미터( * : 필수)
- 필요 값 : popupNo, popupNm, popupImgPathNm, popupImgFileNm, popupCont, langCd

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

filestring · binaryOptional

Responses

200

팝업 다국어정보 등록 및 수정 성공

*/*

timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

900

팝업 다국어정보 등록 및 수정 실패

*/*

post/v2/display/sitePopupMgmt/multiLang

POST /api/bo/v2/display/sitePopupMgmt/multiLang HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 590

{
  "file": "binary",
  "prSitePopupInfo": {
    "siteNo": 1,
    "langCd": "ko",
    "popupNo": 141,
    "popupNm": "팝업테스트 명",
    "popupDispStrDtm": "2023-01-01 00:00:00.000",
    "popupDispEndDtm": "2023-12-31 00:00:00.000",
    "popupTypCd": "01",
    "popupTypCdNm": "팝업",
    "prioRnk": 1,
    "dispMediaCd": 20,
    "popupSzWdt": 10,
    "popupSzHigh": 20,
    "popupLocLeft": 30,
    "popupLocTop": 40,
    "prtTypCd": "01",
    "popupImgPathNm": "/test",
    "popupImgFileNm": "이미지파일명",
    "aosYn": "N",
    "iosYn": "N",
    "popupLnk": "/x2bee.com",
    "popupCont": "팝업테스트내용",
    "useYn": "Y",
    "popContGbCd": "01",
    "chlNo": 1000001,
    "popupTgtScrnListApi": "[01, 02, 03, 04, 05]"
  }
}

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

팝업 상세정보 조회

get

기능설명

팝업 상세정보를 조회하는 API 입니다.

상세설명

팝업번호로 해당 팝업 상세정보를 조회합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

popupNostringRequired

팝업번호

Example: 141

langCdstringRequired

언어코드

Example: ko

Responses

200

팝업 상세정보 조회 성공

*/*

사이트팝업정보

siteNostringOptional

사이트번호

Example: 1

langCdstringOptional

언어코드

Example: ko

popupNostringOptional

팝업번호

Example: 141

popupNmstringOptional

팝업명

Example: 팝업테스트 명

popupDispStrDtmstring · date-timeOptional

팝업전시시작일시

Example: 2023-01-01 00:00:00.000

popupDispEndDtmstring · date-timeOptional

팝업전시종료일시

Example: 2023-12-31 00:00:00.000

popupTypCdstringOptional

팝업유형코드(DP014)

Example: 01

popupTypCdNmstringOptional

팝업유형코드명(DP014)

Example: 팝업

prioRnkinteger · int32Optional

우선순위

Example: 1

dispMediaCdstringOptional

전시매체코드

Example: 20

popupSzWdtinteger · int32Optional

팝업사이즈넓이

Example: 10

popupSzHighinteger · int32Optional

팝업사이즈높이

Example: 20

popupLocLeftinteger · int32Optional

팝업위치 LEFT

Example: 30

popupLocTopinteger · int32Optional

팝업위치 TOP

Example: 40

prtTypCdstringOptional

출력유형코드(DP017)

Example: 01

popupImgPathNmstringOptional

팝업이미지경로명

Example: /test

popupImgFileNmstringOptional

팝업이미지파일명

Example: 이미지파일명

aosYnstringOptional

AOS 전시여부

Example: N

iosYnstringOptional

IOS 전시여부

Example: N

popupLnkstringOptional

팝업링크

Example: /x2bee.com

popupContstringOptional

팝업내용

Example: 팝업테스트내용

useYnstringOptional

사용여부

Example: Y

popContGbCdstringOptional

팝업내용구분코드(DP029)

Example: 01

chlNostringOptional

채널번호

Example: 1000001

popupTgtScrnListApistring[]Optional

전시코너 API 전달용

Example: [01, 02, 03, 04, 05]

900

팝업 상세정보 조회 실패

*/*

get/v2/display/sitePopupMgmt/{popupNo}

GET /api/bo/v2/display/sitePopupMgmt/{popupNo}?popupNo=text&langCd=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "siteNo": 1,
  "langCd": "ko",
  "popupNo": 141,
  "popupNm": "팝업테스트 명",
  "popupDispStrDtm": "2023-01-01 00:00:00.000",
  "popupDispEndDtm": "2023-12-31 00:00:00.000",
  "popupTypCd": "01",
  "popupTypCdNm": "팝업",
  "prioRnk": 1,
  "dispMediaCd": 20,
  "popupSzWdt": 10,
  "popupSzHigh": 20,
  "popupLocLeft": 30,
  "popupLocTop": 40,
  "prtTypCd": "01",
  "popupImgPathNm": "/test",
  "popupImgFileNm": "이미지파일명",
  "aosYn": "N",
  "iosYn": "N",
  "popupLnk": "/x2bee.com",
  "popupCont": "팝업테스트내용",
  "useYn": "Y",
  "popContGbCd": "01",
  "chlNo": 1000001,
  "popupTgtScrnListApi": "[01, 02, 03, 04, 05]"
}

팝업 다국어 상세 정보 조회

get

기능설명

팝업 다국어 상세정보를 조회하는 API 입니다.

상세설명

팝업번호로 해당 팝업 상세정보를 조회합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

popupNostringRequired

팝업번호

Example: 141

langCdstringRequired

언어코드

Example: en

Responses

200

팝업 다국어 정보 조회 성공

*/*

사이트팝업정보

siteNostringOptional

사이트번호

Example: 1

langCdstringOptional

언어코드

Example: ko

popupNostringOptional

팝업번호

Example: 141

popupNmstringOptional

팝업명

Example: 팝업테스트 명

popupDispStrDtmstring · date-timeOptional

팝업전시시작일시

Example: 2023-01-01 00:00:00.000

popupDispEndDtmstring · date-timeOptional

팝업전시종료일시

Example: 2023-12-31 00:00:00.000

popupTypCdstringOptional

팝업유형코드(DP014)

Example: 01

popupTypCdNmstringOptional

팝업유형코드명(DP014)

Example: 팝업

prioRnkinteger · int32Optional

우선순위

Example: 1

dispMediaCdstringOptional

전시매체코드

Example: 20

popupSzWdtinteger · int32Optional

팝업사이즈넓이

Example: 10

popupSzHighinteger · int32Optional

팝업사이즈높이

Example: 20

popupLocLeftinteger · int32Optional

팝업위치 LEFT

Example: 30

popupLocTopinteger · int32Optional

팝업위치 TOP

Example: 40

prtTypCdstringOptional

출력유형코드(DP017)

Example: 01

popupImgPathNmstringOptional

팝업이미지경로명

Example: /test

popupImgFileNmstringOptional

팝업이미지파일명

Example: 이미지파일명

aosYnstringOptional

AOS 전시여부

Example: N

iosYnstringOptional

IOS 전시여부

Example: N

popupLnkstringOptional

팝업링크

Example: /x2bee.com

popupContstringOptional

팝업내용

Example: 팝업테스트내용

useYnstringOptional

사용여부

Example: Y

popContGbCdstringOptional

팝업내용구분코드(DP029)

Example: 01

chlNostringOptional

채널번호

Example: 1000001

popupTgtScrnListApistring[]Optional

전시코너 API 전달용

Example: [01, 02, 03, 04, 05]

900

팝업 다국어 정보 조회 실패

*/*

get/v2/display/sitePopupMgmt/multiLang/{popupNo}

GET /api/bo/v2/display/sitePopupMgmt/multiLang/{popupNo}?popupNo=text&langCd=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "siteNo": 1,
  "langCd": "ko",
  "popupNo": 141,
  "popupNm": "팝업테스트 명",
  "popupDispStrDtm": "2023-01-01 00:00:00.000",
  "popupDispEndDtm": "2023-12-31 00:00:00.000",
  "popupTypCd": "01",
  "popupTypCdNm": "팝업",
  "prioRnk": 1,
  "dispMediaCd": 20,
  "popupSzWdt": 10,
  "popupSzHigh": 20,
  "popupLocLeft": 30,
  "popupLocTop": 40,
  "prtTypCd": "01",
  "popupImgPathNm": "/test",
  "popupImgFileNm": "이미지파일명",
  "aosYn": "N",
  "iosYn": "N",
  "popupLnk": "/x2bee.com",
  "popupCont": "팝업테스트내용",
  "useYn": "Y",
  "popContGbCd": "01",
  "chlNo": 1000001,
  "popupTgtScrnListApi": "[01, 02, 03, 04, 05]"
}

팝업 상세 - 채널적용정보 목록 조회

get

기능설명

채널적용정보 목록을 조회하는 API 입니다.

상세설명

팝업번호에 해당하는 채널적용정보 목록을 조회합니다.

수정번호

Release v1.02_231023 : 스프린트2 PO1 결함/개선

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

popupNostringRequired

팝업번호

Example: 141

Responses

200

채널적용정보 목록 조회 성공

*/*

popupNostringOptional

팝업번호

Example: 141

chlNostringOptional

채널번호

Example: 1000001

chlNmstringOptional

채널명

Example: 플래티어

linkInfostringOptional

연결정보

Example: /x2bee

900

채널적용정보 목록 조회 실패

*/*

get/v2/display/sitePopupMgmt/chlAplyInfo/{popupNo}

GET /api/bo/v2/display/sitePopupMgmt/chlAplyInfo/{popupNo}?popupNo=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "popupNo": 141,
  "chlNo": 1000001,
  "chlNm": "플래티어",
  "linkInfo": "/x2bee"
}

이전표준 전시카테고리연결 다음기획전 그룹 관리

마지막 업데이트 17일 전