이미지 레이아웃

Notification > Notification Hub > API v1.0 사용 가이드 > 이미지 레이아웃

이미지 레이아웃 단건 조회

이미지 레이아웃을 ID 기반으로 단건 조회합니다.

요청

GET /image-layout/v1.0/image-layouts/{id}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

요청 파라미터

이름 구분 타입 필수 설명
X-NC-APP-KEY Header String Y 앱키
X-NHN-Authorization Header String Y 액세스 토큰
id Path String Y 이미지 레이아웃 아이디

요청 본문

이 API는 요청 본문을 요구하지 않습니다.

응답 본문

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  },
  "imageLayout" : {
    "id" : "A9z0A9z0",
    "name" : "2025_프로모션_쿠폰",
    "backgroundImage" : {
      "fileName" : "background.png",
      "filePreviewUrl" : "https://example.com/background.png"
    },
    "cardImage" : {
      "fileName" : "cardImage.png",
      "filePreviewUrl" : "https://example.com/background.png"
    },
    "title" : "#{user}님이 보내신\n#{promotion} 기프트 카드가 도착했어요.",
    "body" : "* 상품명: 오늘의 상품\n*유효기간: #{expirydate}까지\n*사용처: 온/오프라인 매장(일부 매장 제외)",
    "useBarcode" : true,
    "createdDateTime" : "2024-10-29T06:00:01.000+09:00",
    "updatedDateTime" : "2024-10-29T06:00:01.000+09:00"
  }
}
경로 타입 설명
header Object
header.isSuccessful Boolean 요청이 성공했는지 여부를 나타냅니다.
기본값: true
header.resultCode Integer 요청의 결과 코드입니다.
기본값: 0
header.resultMessage String 요청의 결과 메시지입니다.
기본값: SUCCESS
imageLayout Object
imageLayout.id String 이미지 레이아웃 아이디
imageLayout.name String 이미지 레이아웃 이름
imageLayout.backgroundImage Object
imageLayout.backgroundImage.fileName String 배경 이미지 파일 이름
imageLayout.backgroundImage.filePreviewUrl String 배경 이미지 미리보기 URL
imageLayout.cardImage Object
imageLayout.cardImage.fileName String 카드 이미지 파일 이름
imageLayout.cardImage.filePreviewUrl String 카드 이미지 미리보기 URL
imageLayout.title String 제목
imageLayout.body String 본문
imageLayout.useBarcode Boolean 바코드 사용 여부
imageLayout.createdDateTime String 이미지 레이아웃 생성 일시
imageLayout.updatedDateTime String 이미지 레이아웃 수정 일시

요청 예시

IntelliJ HTTP 
### 이미지 레이아웃 단건 조회

GET {{endpoint}}/image-layout/v1.0/image-layouts/{{id}}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}
cURL 
curl -X GET "${endpoint}/image-layout/v1.0/image-layouts/${id}" \
-H "X-NC-APP-KEY: {appKey}"  \ 
-H "X-NHN-Authorization: Bearer {accessToken}"

이미지 레이아웃 등록

이미지 레이아웃을 등록합니다.

요청

POST /image-layout/v1.0/image-layouts
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}
Content-Type: multipart/form-data

요청 파라미터

이름 구분 타입 필수 설명
X-NC-APP-KEY Header String Y 앱키
X-NHN-Authorization Header String Y 액세스 토큰

요청 본문

이름 타입 필수 설명
name String Y 이미지 레이아웃 이름
backgroundImage File Y 배경 이미지 파일
cardImage File Y 카드 이미지 파일
title String Y 제목
body String Y 본문
useBarcode Boolean Y 바코드 사용 여부

응답 본문

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  },
  "id" : "A9z0A9z0"
}
경로 타입 설명
header Object
header.isSuccessful Boolean 요청이 성공했는지 여부를 나타냅니다.
기본값: true
header.resultCode Integer 요청의 결과 코드입니다.
기본값: 0
header.resultMessage String 요청의 결과 메시지입니다.
기본값: SUCCESS
id String 이미지 레이아웃 아이디

요청 예시

IntelliJ HTTP 
### 이미지 레이아웃 등록

POST {{endpoint}}/image-layout/v1.0/image-layouts
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}
Content-Type: multipart/form-data

name=이미지-레이아웃
title=제목
body=본문
useBarcode=true
backgroundImage=@{{pathToImage}}
cardImage=@{{pathToImage}}
cURL 
curl -X POST "${endpoint}/image-layout/v1.0/image-layouts" \
-H "X-NC-APP-KEY: {appKey}"  \ 
-H "X-NHN-Authorization: Bearer {accessToken}"  \
-H 'Content-Type: multipart/form-data' \
-F "name=이미지-레이아웃" \
-F "backgroundImage=@{pathToImage}" \
-F "cardImage=@{pathToImage}" \
-F "title=제목" \
-F "body=본문" \
-F "useBarcode=true"

이미지 레이아웃 삭제

이미지 레이아웃을 삭제합니다.

요청

DELETE /image-layout/v1.0/image-layouts/{id}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

요청 파라미터

이름 구분 타입 필수 설명
X-NC-APP-KEY Header String Y 앱키
X-NHN-Authorization Header String Y 액세스 토큰
id Path String Y 이미지 레이아웃 아이디

요청 본문

이 API는 요청 본문을 요구하지 않습니다.

응답 본문

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  }
}
경로 타입 설명
header Object
header.isSuccessful Boolean 요청이 성공했는지 여부를 나타냅니다.
기본값: true
header.resultCode Integer 요청의 결과 코드입니다.
기본값: 0
header.resultMessage String 요청의 결과 메시지입니다.
기본값: SUCCESS

요청 예시

IntelliJ HTTP 
### 이미지 레이아웃 삭제

DELETE {{endpoint}}/image-layout/v1.0/image-layouts/{{id}}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}
cURL 
curl -X DELETE "${endpoint}/image-layout/v1.0/image-layouts/${id}" \
-H "X-NC-APP-KEY: {appKey}"  \ 
-H "X-NHN-Authorization: Bearer {accessToken}"

이미지 레이아웃 리스트 조회

이미지 레이아웃을 리스트로 조회합니다.

요청

GET /image-layout/v1.0/image-layouts
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}

요청 파라미터

이름 구분 타입 필수 설명
X-NC-APP-KEY Header String Y 앱키
X-NHN-Authorization Header String Y 액세스 토큰
name Query String N 이미지 레이아웃 이름
exact Query Boolean N true인 경우 이미지 레이아웃 이름 완전 일치 검색, false인 경우 LIKE 검색
limit Query Integer N limit 설정하지 않으면 default 20(최대 1000)
offset Query Integer N offset 설정하지 않으면 default 0

요청 본문

이 API는 요청 본문을 요구하지 않습니다.

응답 본문

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  },
  "totalCount" : 1,
  "imageLayouts" : [ {
    "id" : "A9z0A9z0",
    "name" : "2025_프로모션_쿠폰"
  } ]
}
경로 타입 설명
header Object
header.isSuccessful Boolean 요청이 성공했는지 여부를 나타냅니다.
기본값: true
header.resultCode Integer 요청의 결과 코드입니다.
기본값: 0
header.resultMessage String 요청의 결과 메시지입니다.
기본값: SUCCESS
totalCount Integer 총 건수
imageLayouts Array
imageLayouts[].id String 이미지 레이아웃 아이디
imageLayouts[].name String 이미지 레이아웃 이름
imageLayouts[].backgroundImage Object
imageLayouts[].backgroundImage.fileName String 배경 이미지 파일 이름
imageLayouts[].backgroundImage.filePreviewUrl String 배경 이미지 미리보기 URL
imageLayouts[].cardImage Object
imageLayouts[].cardImage.fileName String 카드 이미지 파일 이름
imageLayouts[].cardImage.filePreviewUrl String 카드 이미지 미리보기 URL
imageLayouts[].title String 제목
imageLayouts[].body String 본문
imageLayouts[].useBarcode Boolean 바코드 사용 여부
imageLayouts[].createdDateTime String 이미지 레이아웃 생성 일시
imageLayouts[].updatedDateTime String 이미지 레이아웃 수정 일시

요청 예시

IntelliJ HTTP 
### 이미지 레이아웃 리스트 조회

GET {{endpoint}}/image-layout/v1.0/image-layouts
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}
cURL 
curl -X GET "${endpoint}/image-layout/v1.0/image-layouts" \
-H "X-NC-APP-KEY: {appKey}"  \ 
-H "X-NHN-Authorization: Bearer {accessToken}"

이미지 레이아웃 수정

이미지 레이아웃을 수정합니다. 수정이 필요한 필드만 입력하여 부분 수정이 가능합니다.

요청

PATCH /image-layout/v1.0/image-layouts/{id}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}
Content-Type: multipart/form-data

요청 파라미터

이름 구분 타입 필수 설명
X-NC-APP-KEY Header String Y 앱키
X-NHN-Authorization Header String Y 액세스 토큰

요청 본문

이름 타입 필수 설명
name String N 이미지 레이아웃 이름
backgroundImage String N 배경 이미지 파일
cardImage String N 카드 이미지 파일
title String N 제목
body String N 본문
useBarcode Bolean N 바코드 사용 여부

응답 본문

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  }
}
경로 타입 설명
header Object
header.isSuccessful Boolean 요청이 성공했는지 여부를 나타냅니다.
기본값: true
header.resultCode Integer 요청의 결과 코드입니다.
기본값: 0
header.resultMessage String 요청의 결과 메시지입니다.
기본값: SUCCESS

요청 예시

IntelliJ HTTP 
### 이미지 레이아웃 수정

PATCH {{endpoint}}/image-layout/v1.0/image-layouts/{{id}}
X-NC-APP-KEY: {appKey}
X-NHN-Authorization: Bearer {accessToken}
Content-Type: multipart/form-data

name=이미지-레이아웃
title=제목
body=본문
useBarcode=true
backgroundImage=@{{pathToImage}}
cardImage=@{{pathToImage}}
cURL 
curl -X PATCH "${endpoint}/image-layout/v1.0/image-layouts/${id}" \
-H "X-NC-APP-KEY: {appKey}"  \ 
-H "X-NHN-Authorization: Bearer {accessToken}"  \
-H 'Content-Type: multipart/form-data' \
-F "name=이미지-레이아웃" \
-F "backgroundImage=@{pathToImage}" \
-F "cardImage=@{pathToImage}" \
-F "title=제목" \
-F "body=본문" \
-F "useBarcode=true"
목차
TOP