コネクターキーリファレンス

SDKリファレンス-`test`

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

クイック概要

testlambdaは、コネクションが有効かどうかを確認する方法をconnectorに指示します。ユーザーから入力を取得し、authorizationブロックを実行した後、このテストは、指定された認証情報が有効であることを簡単なHTTPリクエストで検証します。

testlambdaは、ユーザーが初めてconnectをクリックしてコネクションを作成するときに実行されます。唯一の例外はOAuth2 authorization code grantコネクションです。この場合、Workatoがauthorization codeをaccess tokensに正常に交換すると、コネクションはconnectedとしてマークされます。

testラムダは、レシピ開始時およびジョブの再実行時にもすべての種類のコネクションに対して実行され、コネクションの認証情報が引き続き有効であることを確認します。

構造

ruby

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

`test`

属性	説明
キー	`test`
タイプ	ラムダ関数
必須	True
説明	正常なコネクションが確立されたことを検証できる簡単なHTTPリクエスト。 HTTPレスポンスが2XXの場合、このコネクションは"Successful"としてマークされます。

例-test:

APIは通常、認証済みユーザーに関する情報を返すendpointを提供します。これらのendpointは、connectorでコネクションが確立されたことを検証するのに最適です。

ruby

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

これを使用できない場合は、簡単なリクエストを使用することもできます。通常、これはターゲットAPIで結果を検索するために使用できます。これらのリクエストでも、コネクションが有効であることを検証できる必要があります。

ruby

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

Last updated:

SDKリファレンス-test ​

構造 ​

test ​

SDKリファレンス-`test`

構造

`test`