お知らせのWebhookに対応

お知らせ外部連携用にWebhook設定を追加しました

Webhookとは

お知らせの更新(登録,更新,削除)のタイミングで外部システムが公開するHTTPエンドポイントに、更新イベントをHTTPのPOSTメソッドで通知します。

お知らせのWebhookで送信されるデータ

Webhookの呼び出しは、以下のようにHTTP/1.1で行われます。

POST {URLに含まれるパス} HTTP/1.1
Host: {URLのホストパート}
Content-Type: application/json; charset=utf-8

{
    "noticeId":{お知らせの内部ID(long)},
    "dispId":{お知らせNo.},
    "event":"PUBLISH" or "UPDATE" or "DELETE" or "VERIFY",
    "title":"お知らせのタイトル",
    "priority":3(NORMAL) or 4(IMPORTANT) or 7(CRITICAL),
    "keywords":["キーワード1","キーワード2",…],
    "category"[
    {
        "id":{カテゴリグループのID},
        "label":"カテゴリグループのラベル",
        "selected":[{"key":"アイテムのキー","label":"アイテムのラベル"},…]
    },… ],
    "calendarArea":["カレンダー表示位置","週間カレンダースケジュール表示位置"],
    "openDate":"公開日時(UTC)",
    "closeDate":"公開終了日時(UTC)",
    "beginDate":"実施期間の開始日時(UTC)",
    "endDate":"実施期間の終了日時(UTC)",
    "recvStores":["店舗コード1","店舗コード2",…],//送り先店舗を個別の店舗に展開した結果
    "colors":[{"colorsId":"区分のID","label":"区分名"},…],
    "targetStaff":0(全てのスタッフ) or 1(店長あて) or 3(店長+副店長あて) or 4(担当ユーザーあて) or 8(店舗アドバイザーあて),
    "userConcerned":[本部関係者],
    "replyType":0(なし) or 1(店舗ごとに1回答) or 2(店舗ごとに複数回答) or 3(スタッフごとに1回答)
    "replyDueDate":"回答期限",
    "pubUser":{発信者},
    "pubGroup":{発信部署},
    "pdf":[…],//添付PDF
    "tasks":[
    {
        "dueDate":"実施する作業の実施予定日(終了)",
        "beginDate":"実施する作業の実施予定日(開始)",
        "name":"作業内容"
    },…],
    "approvedDate":"公開承認日時"
    "regAccount":{登録ユーザー}
    "updAccount":{最終更新ユーザー}
    "sessionOwner":{操作したユーザー}
    "templateId":9,//お知らせ雛形のID(int),
    "templateName":"お知らせ雛形名",
    "data":{
        "10001": "部品の値のCSVと同じ文字列表現",
        "10002": ... 
    },
    "token": "リクエストの発行元を検証するためのトークン" 
}

Webhookで発行されたtokenの検証

セッション操作APIで、Webhookを生成した発行元が正しいものであるか確認することができます。

• 呼び出しURL

https://your-domain/h2/STRSessionManipurator.do

• リクエスト

パラメータ名	意味	必須	制約
func	動作モード	○	validateWebhookTokenを指定します。
key	WebAPIキー	○	セッション操作APIが利用可能なWebAPIキーを指定します。
token	トークン	○	Webhookで発行されたTokenを指定します。

 

Webhookを設定してみよう

• システムの管理権限が必要となります
• 注意 :  事前にWebhook通知を受けるエンドポイント、プログラムをご準備ください  
  関係の無いURLを登録すると、お知らせに登録された情報が漏れる可能性がございます。

1. [ システムの管理 ] > [ 連携アプリの設定 ] > [ お知らせのWebhookを設定 ] を開く

2. [ Webhookを追加 ]ボタンを押下

3. [ ペイロードURL ] を設定する

   

   項目	説明
   ペイロードURL	外部アプリケーションへ通知するURLを設定する

4. [ 保存する ]ボタンを 押下し、設定を保存する

　 以上で、Webhookの設定は完了です。

Webhookで通知してみよう

• お知らせのWebhookを設定して実施してください

お知らせを公開する

お知らせの公開時にWebhook通知が送られます。

お知らせをメンテナンスする

公開済みのお知らせのメンテナンス時にWebhook通知が送られます。

お知らせを削除する

お知らせの削除時にWebhook通知が送られます。
お知らせの公開承認機能を利用している場合はお知らせの削除承認時に送られます。

Webhookの履歴を確認しよう

• システムの管理権限が必要となります

1. [ システムの管理 ] > [ 連携アプリの設定 ] > [ Webhookの履歴 ] を開く

　下記の情報を、Webhookの履歴画面から確認することができます。

• Webhook通知された時間
• 更新があったお知らせ
• Webbhook通知のステータスコード
• Webhook通知されたペイロードURL

 

また、右端にある"</>"を押下すると、HTTP request/response情報が確認できます。

 

2019年秋バージョン新機能ガイドの記事

• 2019年秋バージョン新機能ガイド
• お知らせのWebhookに対応
• お知らせ送り先の展開保持オプションを追加
• フォトスストックにフォトレポート・売場ノート連携オプションを追加
• その他の機能