汎用REST接続

汎用REST接続は、専用のコネクターがない任意のHTTP/RESTサービスにPlaidCloudを接続します。一般的な認証パターン（なし、基本、APIキー、ベアラートークン、OAuth 2.0）、デフォルトのリクエストヘッダー、リダイレクトとトランスポートのきめ細かな制御、フォーム内のリクエストテスターに対応しています。

Savantインポーターなどのコンバーターは、暗号化されたシークレット値を保持するREST接続を作成できます。変換されたステップは、実行時にそれらの値を使用します。

設定

フォームには4つのタブがあります。

接続の詳細

フィールド	タイプ	説明
接続名	テキスト	この接続の表示名。
メモ	テキスト（複数行）	接続に関する任意のメモ。
ホストまたはIPアドレス	テキスト	リクエストの宛先となるベースホスト。
有効（アクセスを許可）	トグル	接続を有効にするかどうか。削除せずに一時停止するには無効にします。
認証タイプ	選択	`None`、`Basic`、`API Key`、`Bearer Token`、`OAuth 2.0`、`Azure Cosmos DB (Master Key)`、`Azure Cosmos DB (Microsoft Entra ID)`のいずれか。タイプを選択すると、認証タブの対応するグループが有効になります。
セキュリティモデル	選択	接続を使用できるユーザー。プライベート、特定のメンバー、特定のセキュリティグループ、すべてのワークスペースメンバーのいずれか。

接続設定

設定	デフォルト	説明
SSL証明書の検証を有効にする	オフ	リクエストの送信時にSSL証明書を検証します。検証に失敗するとリクエストは中止されます。
リダイレクトに自動的に従う	オン	HTTP 3xxレスポンスをリダイレクトとして扱い、従います。
元のHTTPメソッドに従う	オフ	デフォルトのGETによるリダイレクトではなく、元のHTTPメソッドでリダイレクトします。
Authorizationヘッダーに従う	オフ	リダイレクト時にAuthorizationヘッダーを保持します。
リダイレクト時にRefererヘッダーを削除	オフ	リダイレクト時にRefererヘッダーを削除します。
厳格なHTTPパーサーを有効にする	オフ	無効なHTTPヘッダーを含むレスポンスを拒否します。
URLを自動的にエンコード	オン	URLのパス、クエリパラメーター、認証フィールドをエンコードします。
Cookie Jarを無効にする	オフ	このリクエストのCookieをCookie Jarに保存せず、保存済みのCookieもヘッダーとして送信しません。
ハンドシェイク時にサーバーの暗号スイートを使用	オフ	ハンドシェイク時に、クライアントの順序ではなくサーバーの暗号スイートの順序を使用します。
リダイレクトの最大数	10	従うリダイレクト数の上限。

API定義

任意です。APIのOpenAPI 3.xまたはSwagger 2.0の定義を接続に添付すると、その接続を使用するRESTリクエストステップで、メソッド、パラメーター、リクエスト本文が入力された状態でAPIのエンドポイントを一覧表示できます。ステップごとに定義を記述し直す必要はありません。

フィールド	タイプ	説明
定義	選択	`None`、`OpenAPI / Swagger URL`、`OpenAPI / Swagger file`のいずれか。
定義URL	テキスト	仕様が公開されているアドレス（例：`https://api.example.com/openapi.json`）。URLを選択した場合に表示されます。
定義ファイル	ファイル	Documentに保存された`.json`または`.yaml`の仕様。ファイルを選択した場合に表示されます。

RESTリクエストステップで、この接続を選択し、エンドポイントソースを接続のAPI定義からに設定して、カタログをロードを選択します。

認証

選択したAuthentication Typeに対応するグループのみが表示されます。Noneの場合、このタブは無効になります。

基本

フィールド	タイプ	説明
ユーザー	テキスト	基本認証のユーザー名。
パスワード	パスワード	基本認証のパスワード（書き込み専用）。

APIキー

フィールド	タイプ	説明
キー	テキスト	APIキーのフィールド名。
値	テキスト	APIキーの値。

ベアラートークン

フィールド	タイプ	説明
トークン	パスワード	ベアラートークン（書き込み専用）。

OAuth 2.0

フィールド	タイプ	説明
認証データの追加先	選択	認証データを`Request Headers`または`Request URL`のどちらで送信するか。
ヘッダープレフィックス	テキスト	Authorizationヘッダー値のプレフィックス（デフォルトは`Bearer`）。
認証URL	テキスト	認可エンドポイント。
アクセストークンURL	テキスト	トークンエンドポイント。
クライアントID	テキスト	OAuthクライアント識別子。
クライアントシークレット	テキスト	OAuthクライアントシークレット。
リフレッシュトークンURL	テキスト	トークンの更新に使用するエンドポイント。
初期リフレッシュトークン	テキスト	最初の交換に使用するシードのリフレッシュトークン。
追加のトークンリクエストパラメーター	テーブル	トークンリクエストで送信される追加の本文パラメーター（有効、名前、値、説明）。
追加のトークンリクエストヘッダー	テーブル	トークンリクエストで送信される追加のヘッダー（有効、名前、値、説明）。

Azure Cosmos DB (マスターキー)

フィールド	タイプ	説明
マスターキー	パスワード	Cosmos DBアカウントのマスターキー（書き込み専用）。Cosmos DB REST APIの要件に従い、各リクエストはこのキーで署名されます。

Azure Cosmos DB (Microsoft Entra ID)

フィールド	タイプ	説明
アクセストークンURL	テキスト	テナントのトークンエンドポイント（例：`https://login.microsoftonline.com/<tenant>/oauth2/v2.0/token`）。
クライアントID	テキスト	EntraアプリケーションのクライアントID。
クライアントシークレット	パスワード	Entraアプリケーションのクライアントシークレット（書き込み専用）。

コンテナー内のドキュメントをクエリして書き込むには、Cosmos DB接続をRESTリクエストステップと組み合わせて使用します。接続のベースURLには、Cosmos DBアカウントのエンドポイントを設定します。

デフォルトヘッダー

この接続を通じたすべてのリクエストで送信されるヘッダーのテーブルです。各行にはEnabled、Header Name、Value、Descriptionがあります。行のボタンを使用して、ヘッダーを追加、挿入、削除します。これらのヘッダーは、ページング読み取りの各ページや行ごとのファンアウトの各リクエストを含め、接続が行うすべてのリクエストで送信されます。個別のステップで設定したヘッダーは、ここにある同名のヘッダーより優先されます。

テスト

保存済みの接続を通じてアドホックなリクエストを送信し、動作を確認します。

フィールド	タイプ	説明
テスト用エンドポイント	テキスト	呼び出す完全なURL（例：`https://example.com/rest/test/validate`）。
メソッド	選択	`GET`、`PUT`、`POST`、`DELETE`、`HEAD`、`OPTIONS`のいずれか。
ペイロード	コード	リクエスト本文。Django/Jinja形式のテンプレートトークンに対応しています。
テストリクエストを送信	ボタン	リクエストを送信し、レスポンス（またはエラー）を表示します。