Japanese (日本語)

POSTメソッドを使用したアラートの設定

ウェブフック は、プロセスで何かが起きたときにユーザー、他のアプリケーション、またはITシステムに通知する仕組みです。データをアップロードした後、一部のタイムラインが設定された条件を満たしている場合、アプリケーションは対応する通知を送信します。

ウェブフックの作成に使用できるメソッドのひとつにPOSTがあります。Timelineは新しいHTTP POSTリクエストを作成し、指定されたURLアドレスに送信します。

ウェブフックの作成方法

  1. をクリックしてアラート編集ウィンドウを開きます。
    重要。ウェブフックを作成する前に、アラートを追加して設定する必要があります。手順については、「アラートの作成と実行方法」を参照してください。
  2. ウェブフックセクションでをクリックします。
  3. POSTメソッドを選択します。
  4. ウェブフックのパラメータを設定します。
    設定の中には、任意のものもあります。パラメータは下表のとおりです。
パラメータ 説明
URL 情報の送信先となる有効なURL。
HTTPベーシック認証 (オプション)

ウェブフックで認証が必要な場合に使用する有効な認証情報。

認証情報を設定するには:

  1. HTTPベーシック認証オプションを選択します。
  2. ユーザー名パスワードを入力します。
ウェブフック名 レポートに表示されるウェブフック名。アラートの識別に役立ちます。
リクエストヘッダー (オプション)

POSTリクエストに含まれる追加のHTTPヘッダーとその値。

ヘッダーを追加するには:

  1. 名前を入力します。
  2. をクリックします。
コンテンツタイプ:マルチパート タイムラインIDフィールド名
一致したタイムラインIDを含む配列名。
たとえば、条件を満たす3つのタイムラインがあり、そのIDは次の配列を形成します:
["45B87","3A584","C954T3"]
コンテンツタイプ: JSON
  • カスタムプロパティ(オプション)
    JSONファイルの固定部分にすることができるカスタムプロパティ。これらのフィールドは文字列属性のみを受け入れます。
    たとえば、このようなカスタムプロパティを使用して、リクエストがTimelineから送信されたことを識別できます。カスタムプロパティを指定するには:
  1. キーを入力します。
  2. をクリックします。
  • タイムラインIDフィールド名(オプション)
    一致するタイムラインIDを含む配列名。
  • プレビュー
    テスト値を持つJSON構造の例。
  1. テストをクリックして、ウェブフックが正しく設定されていることを確認します。
    設定されたURLにテスト情報を含むPOSTリクエストが表示されます。
  2. 保存をクリックします。

コンテンツタイプ

ウェブフックの設定中に、送信するコンテンツを次のように選択できます:

  1. マルチパート
    境界で区切られた異なる部分で構成されているデータ。各パートは個別のエンティティであり、独自のHTTPヘッダーを持っています
    注:指定されたイベント属性はマルチパートコンテンツに含まれていません。
    送信された文書は2つの部分に分かれています:
    1. ウェブフック名の値。
    2. 一致したタイムラインのIDを格納する配列。

      マルチパートコンテンツの例を表示

  1. JSON
    リクエストには、指定されたイベント属性を持つJSONファイルが含まれます。送信されたデータには以下が含まれます:
    1. ウェブフック名の値。
    2. 一致したタイムラインのIDを格納する配列。
    3. 各要素がタイムラインIDと接続された属性を次の形式で含む配列:
      [{"id":"TimelineID", "EventName / AttributeName": "AttributeValue"}, {...}]
    4. カスタムプロパティ値。

      コメント付きのJSONファイルの例を表示する

JSON構成例

タスク:発生したアラートに関する情報を含むJSONファイルを送信するウェブフックを作成します。

ソリューション:ウェブフックウィンドウで、ポストメソッドを選択し、ウェブフックURLと名前を指定します。コンテンツタイプにJSONを選択します。タイムラインIDが入った配列の名前を設定します。Order IDsなどです。必要に応じてカスタムプロパティを追加します。たとえば、キーフィールドにSourceを入力し、フィールドにTimelineを入力します。

05.09.2024 16:23:55

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.