Webhook

PANAMA スタジオのWebhook

PANAMA スタジオのWebhook は、画像加工完了のイベントを、ご登録いただいたWebhook URL に通知します。リアルタイムに撮影完了のイベントを受け取ることと、画像の変更(再撮影や再加工)が可能になります。 逆に言えば、撮影完了の通知が不要で、再撮影もしない場合にはこの通知を受け取る必要はありません。

認証

PANAMA スタジオのWebhook は、指定されたWebhook URL にリクエストをPOST します。POST 前に認証が必要な場合、各種認証手続きに対応します。

リクエストの構造

ヘッダ

以下のヘッダで返します。

 

Content-Type application/json
User-Agent PANAMA-バージョン(例:PANAMA-v1.0.3)
Accept-Language ja,en-US;q=0.8,en;q=0.6

ボディ

以下のJSON オブジェクトを返します。

 

domain String EC サイトのドメイン名です。
albums[] album オブジェクトの配列です。
albums[].albumCode String 入力したアルバムコードです。
albums[].updated timestamp アップロードされた写真の画像加工を終了した日時です。UTC の時間で返ってきます。
albums[].version number アルバムのバージョン情報です。
albums[].images[] image オブジェクトの配列です。
albums[].images[].position number アルバム内の枝番号で、0 スタートです。
albums[].images[].url String パーマネントURL(画像加工後)。 画像が更新されても、変わらず使えるURL です。キャッシュされるので「PANAMA スタジオでは更新しているのに、ユーザ画面に反映されない」と言う事が発生します。
albums[].images[].randomUrl String ユニークURL(画像加工後)。 画像が更新されると、変更されるURL のためキャッシュが有効に機能します。「PANAMA スタジオでは更新しているのに、ユーザ画面に反映されない」と言う事は発生しません。
albums[].images[].originalUrl String 画像加工前の撮影データそのままのURL です。アップロード前の写真と見た目は同じでもWEB 最適化しています。
albums[].images[].originalName String アップロード時に使った写真のファイル名です。

リクエストのサンプル


 {
    "domain": waja.jp,
    "albums": [
       {
         "albumCode": albumecode-a,
         "updated": EEE MMM dd HH:mm:ss zzz yyyy,
         "version": 1234567,
         "images": [
            {
              "position": 0,
              "url": "https://ids.panama.waja.co.jp/image/waja.jp/albumecode-a/0.jpg,"
              "randomUrl": "https://ids.panama.waja.co.jp/image/waja.jp/albumecode-a/0-qiswR7_6GBM2hqfq5jVuvQkbE18klEIZ.jpg",
              "originalUrl": "https://ids.panama.waja.co.jp/image/original/waja.jp/albumecode-a/0-n7UvkmeB85Fp5WGbdIy_GtBRETIAfeQp.jpg",
              "originalName": "G2yfbKihTu.jpg"
            },
            {
              "position": 1,
              "url": "https://ids.panama.waja.co.jp/image/waja.jp/albumecode-a/1.jpg",
              "randomUrl": "https://ids.panama.waja.co.jp/image/waja.jp/albumecode-a/1-3CrVm5_3jl93.oSD7m_Bwc.w.GYNelnf.jpg",
              "originalUrl": "https://ids.panama.waja.co.jp/image/original/waja.jp/albumecode-a/1-gbMe3wi02esnble.DIjL_oNEm_rkvqfu.jpg",
              "originalName": "v93iKMXzCG.jpg"
            }
          ]
       },
       {
         "albumCode": "albumecode-b",
         "updated": "EEE MMM dd HH:mm:ss zzz yyyy",
         "version": 1234567,
         "images": [
            {
              "position": 0,
              "url": "https://ids.panama.waja.co.jp/image/waja.jp/albumecode-b/0.jpg",
              "randomUrl": "https://ids.panama.waja.co.jp/image/waja.jp/albumecode-b/0-hk9b9BKXZW06nJ7pO4Ii4nvrKwjCakQy.jpg",
              "originalUrl": "https://ids.panama.waja.co.jp/image/original/waja.jp/albumecode-b/0-Q_9LFZ1Y0d.liRcg3vvcNiafWf10QTqG.jpg",
              "originalName": "0.jpg"
            },
            {
              "position": 1,
              "url": "https://ids.panama.waja.co.jp/image/waja.jp/albumecode-b/1.jpg",
              "randomUrl": "https://ids.panama.waja.co.jp/image/waja.jp/albumecode-b/1-_cR6AmKQtZAoZ9q7IeePERn6_DVk1v9z.jpg",
              "originalUrl": "https://ids.panama.waja.co.jp/image/original/waja.jp/albumecode-b/1-PxnRW7hUzGsZNfNaG5KLxadivZymZVkE.jpg",
              "originalName": "v93iKMXzCG.jpg"
            }
          ]
       }
    ]
 }