＜2020年秋バージョンリリース機能＞
業務アプリのWebhookにおいて、画像や添付ファイルの有無だけでなくバイナリデータをダウンロードできるよう拡張いたします。
業務アプリの画像・添付ファイルが取得可能に！
- 業務アプリの文書に登録された画像・添付ファイルのデータ情報を追加
- 画像・添付ファイルのデータ情報から、バイナリデータを取得するWebAPIを追加
- Shopらんと外部アプリケーション間でよりシームレスな連携が可能に
Webhookとは
Webhookとは、業務アプリの文書が登録・更新・削除されたタイミングで外部アプリケーションに通知する仕組みです。詳細は下記ページをご参照ください。
利用イメージ
WebhookとWebAPIを利用しファイルをダウンロード
- Webhookで送信されるデータより画像・添付ファイルのkeyを取得する
- 取得したkeyを用いてWebAPI経由でファイルのバイナリデータをダウンロードする
使ってみよう
業務アプリのWebhookを設定してみよう
- 業務の管理権限が必要となります。
- [業務の管理]>[業務アプリの設定]>任意の業務アプリの[編集]を開く
- [開発者向け機能]>[Webhookの設定]を開く
- [ペイロード形式バージョン]を「2」に設定する
項目 説明 ペイロード形式バージョン ペイロードJSONデータ形式のバージョンを指定します。
1：画像・添付ファイルのkeyを含まない、従来通りのJSONデータを送信します
2：画像・添付ファイルのkeyを含めたJSONデータを送信します
Webhookで送信される画像・添付ファイル情報を確認してみよう
Webhookで送信されるデータのうち、部品データは ”data” で確認できます。
画像部品、ファイル添付部品を利用している場合は下記のようなデータが送信されます。
＜画像部品＞
画像部品を3つ用意しているときに、それぞれに画像ファイルが添付されている場合
"data":{
"10001": {
"bytes": ファイルのbyteサイズ,
"fileName": "ファイル名",
"key": "ファイルダウンロードAPI用のkey"
},
"10002": {
"bytes": 10916487,
"fileName": "image_test_2.png",
"key": "qMcoM7CPt-LpPDTpC45J06bz8Y5tuxTs9DiuQRdSNpz4VRR76K2u825pCsPhtlD5X0vyblSON.DLE0UuFGPrPkpXX0pRs-LUBXtlaPNUbEvy.DOLPasgdrcz9Idlp8pjGyh"
},
"10003": {
"bytes": 10473459,
"fileName": "image_test_3.png",
"key": "Lx5igTL6kpx6d41ZMQ97PO57dXAUnIUaeFVTcbYXhi3PhX95lq9N39duFy5J81T5EcoqOBIouiJ18RPJNIo5ugNCHq0aSzXyoqkwVIZCVOlyr5yGqaE-gtGAtV-2fkW2dLaq0FCiK87ZRw_"
},
},
画像ファイルが添付されていない場合
"data":{
"10001": null
"10002": null
"10003": null
},
＜ファイル添付部品＞
ファイル添付部品を1つ用意しているときに、複数ファイルが添付されている場合
"data":{
"10001": [
{
"bytes": ファイルのbyteサイズ,
"fileName": "ファイル名",
"key": "ファイルダウンロードAPI用のkey"
},
{
"bytes": 325737,
"fileName": "attached_file_test_2.pdf",
"key": "j1JhWtXBKhBulnl0Yy4siM9MKvRD-OWl8URpdnnhEJYYx1dZG4Mgz9TlhrcSIRxR.glqqGw8yrPNDawJAxfhIVtoyPLtmU0iatGk5sdfoGJK3ZelGHdNYwYDUcB9NVGWiCv"
},
{
"bytes": 118183,
"fileName": "attached_file_test_3.pdf",
"key": "aAAsLwKI9qcwYniLcELSkUD9soTaaqJdv-f6sgKcipL9HfZa4xyCYZrc6XDH-.EepgxTNhJjJp68i37q8RGB3SKDES9DvzEpl3NJuquDG3dVB3Wymt2WxiOCg__"
}
]
},
ファイルが添付されていない場合
"data":{
"10001": []
},
WebAPIでファイルをダウンロードしてみよう
Webhookで取得したファイルの "key" をパラメータとしてファイルのダウンロードAPIを呼び出します。
リクエストヘッダーにはWebAPIキーを指定し認証を行います。
- 呼び出しURL
https://your-domain/h2/api/v1/app/download-attachment
- リクエストヘッダー
| ヘッダー名 | 必須 | 制約 |
| X-ShopRun-Auth | ○ | 業務アプリ操作APIの権限があるWebAPIキーを指定します。 |
- リクエストパラメータ
| パラメータ名 | 必須 | 制約 |
| appId | ○ | 業務アプリのIDを指定します。 |
| key | ○ | Webhookで取得した各ファイルのkeyを指定します。 |