SDK リファレンス - test

このセクションでは、接続をテストするときに使用できるすべてのキーを列挙します。

簡単な概要

test キーは、接続が有効かどうかをチェックする方法をコネクターに指示します。コネクターがユーザーからの入力を取得して authorization ブロックを実行した後、このテストはシンプルな HTTP リクエストを使用して接続が有効であることを確認します。

Workato では、接続の成功を確認するために、シンプルなテストを定義する必要があります。そうしたテストは基本的に、すべてのユーザーが常に利用できる HTTP リクエストでなければなりません。このテストは、connection キー内に配置された命令の実行が済むと、その直後に実行されます。

構造

    test: lambda do |connection|
      # see test: documentation for more information
    end

---

test

属性	説明
キー	test
型	lambda 関数
必須	必須です。
説明	接続が問題なく確立されたことを確認できるシンプルな HTTP リクエスト。HTTP レスポンスが 2XX の場合、この接続には "Successful" という表示が付きます。

例 - test:

API には通常、認証済みのユーザーに関する情報を返すエンドポイントが用意されています。こうしたエンドポイントは、接続が確立されたことをコネクターが確認するために最適です。

    test: lambda do |connection|
      get('/api/v5/me')
    end

それを利用できない場合には、シンプルなリクエストの使用を選択できます。これには通常、ターゲット API における検索結果のリクエストを利用できます。そのようなリクエストでは、接続が有効であるかどうかを確認できることも要件となります。

    test: lambda do |connection|
      get("https://person.clearbit.com/v1/people/email/[email protected]")
    end