画像レイアウト

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}

リクエストパラメータ

リクエストボディ

この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"
  }
}

リクエストの例

### 画像レイアウトの個別照会

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

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

リクエストパラメータ

リクエストボディ

レスポンスボディ

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  },
  "id" : "A9z0A9z0"
}

リクエストの例

### 画像レイアウトの登録

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 -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}

リクエストパラメータ

リクエストボディ

このAPIはリクエストボディを要求しません。

レスポンスボディ

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  }
}

リクエストの例

### 画像レイアウトの削除

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

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}

リクエストパラメータ

リクエストボディ

このAPIはリクエストボディを要求しません。

レスポンスボディ

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  },
  "totalCount" : 1,
  "imageLayouts" : [ {
    "id" : "A9z0A9z0",
    "name" : "2025_プロモーション_クーポン"
  } ]
}

リクエストの例

### 画像レイアウトのリスト照会

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

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

リクエストパラメータ

リクエストボディ

レスポンスボディ

{
  "header" : {
    "isSuccessful" : true,
    "resultCode" : 0,
    "resultMessage" : "SUCCESS"
  }
}

リクエストの例

### 画像レイアウトの修正

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 -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"