サポート (英語のみ)

サービス/API Thinklet

サービス/API Thinkletは、次のコネクタ認証情報タイプをサポートしています:

ベーシック

ベアラー

OAuth 2.0 - クライアント認証情報

OAuth 2.0 - 認可コード

認証なし

サービス/API Thinkletは外部の公開APIにRESTコールを行います。 追加の情報を取得したり、アクションの実行をリクエストするために使用します。

サービス/API Thinkletは次の呼び出し方法をサポートしています:

  • GET

  • POST

  • PATCH

  • PUT

  • DELETE

サービス/API Thinkletのサポートされるペイロードと応答はJSONフォーマットです。

  • 名前: サービス/API Thinkletのためのユニークな名前を入力してください。

  • ID: システムは名前に基づいてIDを自動的に生成します。

  • 説明 (オプション): Thinkletの目的とその機能を説明してください。 この情報は、ワークフロー内であまり知られていない他のユーザーにとって役立ちます。

  • 資格情報: 統合のための接続認証情報を選択してください。 まず、管理モジュールのコネクタ資格情報ページでそれらを設定する必要があります。

  • リクエストメソッド: リクエスト接続方法を選択してください。

  • リソース: 接続のエンドポイントを入力してください。

  • カスタムヘッダーを追加: 必要に応じて最大5つのカスタムヘッダーを追加して追加のメタデータを渡します。 代わりに資格情報に認証ヘッダーを追加する必要があります。

  • ペイロード: 外部システムに送信するJSONペイロードを入力します。

  • JSONのAPI呼び出し応答からデータを収集するために、JSONの解析言語を選択します。

すべての表現は、選択されたJSONの解析言語を使用する必要があります。

APIコールからデータを収集

サービス/APIシンクレット設定から、外部システムからのAPI呼び出し応答からデータを収集するためのサポートされているJSONの解析言語を選択します。

  • JSONata（推奨）：これはJSONの強力なクエリおよび変換言語です。 複雑なフィルタリング、計算、データ再構築を可能にします。

  • JSONPath：JSONからフィールドを抽出するためのシンプルな言語です。 システムが簡単なデータアクセスパスを期待する場合に一般的に使用されます。

サービス/APIシンクレットは、外部システムからの応答を待つのに最大10秒かかり、それ以降は呼び出しを失敗と見なします。

外部システムからの応答は、サービス/APIシンクレットの出力構成に関係なく、2MBを超えてはなりません。

出力構成

システムは1つのシンクレットにつき最大5つの出力をサポートしています。

最大出力サイズは30KBまたは3840文字です。

サービス/APIシンクレットのJSONの解析言語を選択した後、データ出力設定を定義します。

  1. 出力を追加ボタンをクリックします。

  2. 条件やシンクレット入力で使用するための参照名前を指定します。

  3. 選択されたJSON構文を使用してデータの選択および変換の式を定義します。

以下に、APIサンプル応答からデータを抽出するためのJSONPathおよびJSONataの表現例を示します：

 {
  "result": { "number": "INC001" },
  "value": [
    { "displayName": "Alice", "id": 1, "number": 50 },
    { "displayName": "Bob", "id": 2, "number": 120 }
  ],
  "@meta": { "key.with.dots": "yes" }
}
出力用のJSONPath式の例

これらの表現例を使用して、API応答から特定のデータを抽出します。

ユースケース
表現 - JSONPatch
上記のAPIサンプル応答の結果

ルート要素

$

(すべてのJSON)

キーへのアクセス

$.result

{ "number": "INC001" }

ネストされた要素へのアクセス

$.result.number

"INC001"

配列の最初の要素

$.value[0].displayName

"Alice"

キーに特別な文字が含まれている

$['@meta']['key.with.dots']

"yes"

出力用のJSONata式の例

これらの表現例を使用して、API応答から特定のデータを抽出します。

ユースケース
式 - JSONata
上記のAPIサンプル応答の結果

トップレベルのキーへのアクセス

結果

{ "number": "INC001" }

ネストされた要素へのアクセス

result.number

"INC001"

配列の最初の要素

value[0].displayName

"Alice"

条件によるフィルタ

value[number > 100].displayName

[ "Bob" ]

マッピングおよび変換

value.{ "name": displayName, "id": id }

[ { "name": "Alice", "id": 1 }, { "name": "Bob", "id": 2 } ]

計算の実行

value[0].number * 100

5000

集計

sum(value.number)

170

テスト中にJSONPathまたはJSONataを解析するためのオンラインコンバーターツールを使用してください。

ペイロードにデータベースおよびワークフロー値を使用する

ワークフロー実行中に収集されたデータとともに、usersおよびdevicesのデータをリソースおよびペイロードフィールドで参照してください。

パラメーターと動的な値のドキュメントを参照して、動的な値を参照する方法の詳細を確認してください。

Last updated

Was this helpful?