팝업 정보 관리

팝업 정보 목록 조회

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
chevron-right
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]
get
/v2/display/sitePopupMgmt

팝업 상세내용 등록/수정

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
chevron-right
200

팝업정보 등록 및 수정 성공

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

post
/v2/display/sitePopupMgmt

팝업 관리 목록 삭제

delete

기능설명

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


상세설명

  • 팝업번호를 입력받아 해당 팝업정보를 삭제합니다.

  • 팝업번호는 필수값입니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Bodyobject[]

사이트팝업정보

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
chevron-right
200

팝업 정보 삭제 성공

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

delete
/v2/display/sitePopupMgmt

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

post

기능설명

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


상세설명

  • 팝업 내용이 HTML 경우 다국어 HTML, 이미지일 경우 다국어 이미지를 등록한다.

  • 입력 파라미터( * : 필수)

    • 필요 값 : popupNo, popupNm, popupImgPathNm, popupImgFileNm, popupCont, langCd

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
filestring · binaryOptional
Responses
chevron-right
200

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

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

post
/v2/display/sitePopupMgmt/multiLang

팝업 상세정보 조회

get

기능설명

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


상세설명

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
popupNostringRequired

팝업번호

Example: 141
langCdstringRequired

언어코드

Example: ko
Responses
chevron-right
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]
get
/v2/display/sitePopupMgmt/{popupNo}

팝업 다국어 상세 정보 조회

get

기능설명

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


상세설명

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
popupNostringRequired

팝업번호

Example: 141
langCdstringRequired

언어코드

Example: en
Responses
chevron-right
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]
get
/v2/display/sitePopupMgmt/multiLang/{popupNo}

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

get

기능설명

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


상세설명

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


수정번호

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
popupNostringRequired

팝업번호

Example: 141
Responses
chevron-right
200

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

*/*
popupNostringOptional

팝업번호

Example: 141
chlNostringOptional

채널번호

Example: 1000001
chlNmstringOptional

채널명

Example: 플래티어
linkInfostringOptional

연결정보

Example: /x2bee
get
/v2/display/sitePopupMgmt/chlAplyInfo/{popupNo}

Last updated