3.11. REST-APIを利用する

本システムでは、対象システムから送信されるアラートをエスカレーションとして通知する方法として、「メール連携」「CTI連携」「Webhook連携」「REST-API」があります。
REST-APIでは、指定したURLにHTTP(GET)リクエストすることで外部サービスと連携することができます。
REST-APIを使用してエスカレーションする場合、REST-API連携先の設定が必要です。

注釈

REST-API連携先の登録、変更、削除の操作は、管理者ユーザアカウントまたは運用者ユーザアカウントで実施可能です。 保存可能なREST-API連携先のURLは1プロジェクトにつき、5件です。

設定したREST-APIは、以下に示すケースにおいて、連携設定を有効にする必要があります。
  • パターン定義にマッチングしたアラートをREST-APIでエスカレーションする場合

    パターン管理における[REST-API有無]を[連携する]に設定します。
    パターン管理の設定方法に関しては、 パターン管理 を参照してください。
  • 複合パターン定義にマッチングしたアラートをREST-APIでエスカレーションする場合

    複合パターン管理における[REST-API有無]を[連携する]に設定します。
    複合パターン管理の設定方法に関しては、 パターン管理 を参照してください。
  • パターン定義にマッチングしなかったアラートをREST-APIでエスカレーションする場合

    プロジェクト管理における[REST-API有無]を[連携する]に設定し、かつパターンアンマッチの[REST-API有無]を[連携する]に設定します。
    プロジェクト管理の設定方法に関しては、 プロジェクト管理 を参照してください。

3.11.1. REST-API連携先を設定する

  1. 運用ポータルにログインし、対象プロジェクトに遷移する
    ※既に対象プロジェクトに遷移している場合は不要です。
  2. REST-API連携先を設定する
    1. ) プロジェクト管理 ‣ プロジェクト一覧 メニューをクリックします。

    2. ) REST-APIを行うプロジェクトを選択して 修正 ボタンをクリックします。

    3. ) [REST-API利用設定]の[REST-API有無]を[連携する]に選択して、[REST-API名称]、[URL]にREST-API連携先のURLを入力します。

    4. ) REST-API連携先の入力が完了したら、 更新 ボタンをクリックします。

    5. ) 登録確認を促すダイアログが表示されますので、 OK ボタンをクリックします。

    6. ) 登録完了後、登録完了ダイアログが表示されますので、 OK ボタンをクリックします。

    REST-API連携先情報の設定に関する詳細は、 プロジェクト編集 を参照してください。

3.11.2. Webhook連携とREST-APIの違い

Webhook連携とREST-APIの違いについて説明します。
  • Webhook連携

    HTTP(POST)通信のリクエストボディにアラートの情報を含めて、JSON形式で指定のURLに送信します。
  • REST-API

    HTTP(GET)通信のリクエストボディは無く、指定のURLと連携します。
    アラートの情報を送信することはできません。