Key Capabilities
- すべてのHTTP メソッド（GET、POST、PUT、PATCH、DELETE）をサポートする完全なRESTful API クライアント
- API の自動設定とリクエスト生成のためのSwagger インポート機能
- OAuth 2.0、Bearer Token、AWS Signature、Basic / Digest 認証を含む高度な認証
- URL、ヘッダー、フォームデータでのScript サポートによる動的なリクエスト構築
- raw、form-data、URL エンコード、ファイルアップロードを含む柔軟なボディタイプ
Overview
REST コネクタは、REST リクエストのヘッダー、認可、ボディ、HTTP メソッドを構築するためのシンプルなインターフェースを公開します。リクエストボディは、コネクタの設定で静的に設定することも、コネクタが処理するファイルに基づいて動的に生成することもできます。Actions
Connector Configuration
REST Details Tab
コネクタのリクエスト詳細に関連する設定。
Authentication
REST サービスでの認証に関連する設定。Request Details
| 設定 | 説明 |
|---|---|
| Import from Swagger |  アイコンをクリックすると、Swagger URL から直接API の詳細をインポートできます。 |
| Test | フローに送信されるメッセージやトランザクションを作成せずに、現在の設定をテストします。Test をクリックすると、4つのタブを持つウィンドウが開きます（詳しくは、Testing Request Configurationsを参照してください）： Response Body：サーバーからの応答のボディを表示します。 Response Headers：サーバーからの応答に含まれていたヘッダーを表示します。 Message Headers：テストの出力に含まれていたメッセージヘッダーを表示します。 Log：コネクタログを表示します。 |
| Action | コネクタが実行するアクション。（3つのオプションの詳細については、Actionsを参照してください。） |
| Request URL | REST リクエストのHTTP メソッドとターゲットHTTP URL。利用可能なメソッドのオプションは、GET、POST、PUT、PATCH、DELETE です。 |
| Body Type | REST リクエストとともに供給されるボディコンテンツの種類。HTTP メソッドがGET の場合は表示されません。各オプションの説明については、Body Typesを参照してください。 |
| Headers | Headers タブでは、送信するREST リクエストに含めるHTTP ヘッダーの一覧を追加できます。ヘッダーは名前と値のペアとして指定します。詳しくは、Static Requestsを参照してください。 |
| Body | Body Type がform-data またはx-www-urlencoded に設定されている場合は、Body タブを使用して、リクエストのボディを構成する名前と値のペア（フィールド）のセットを供給します。詳しくは、Body Typesを参照してください。 |
Settings Tab
コネクタのコアとなる設定に関連する設定。Configuration
Advanced Settings
Advanced Tab
TLS Client Authentication
Advanced Settings
前のカテゴリに含まれない設定。Proxy Settings
Logging
Miscellaneous
Automation Tab
Automation Settings
コネクタによるファイルの自動処理に関連する設定。Performance
Alerts Tab
SLAs Tab
Transactions Tab
このタブには、コネクタに関連するすべてのメッセージが一覧表示されます。検索バーを使用して特定のメッセージを見つけるか、じょうごアイコンをクリックしてフィルタを適用します。時間、メッセージの方向、ステータスでフィルタリングできます。 このタブのオプションは、コネクタのアクションタイプによって異なります：- コネクタがTrigger の場合は、Receive Files ボタンを使用してフローを開始します。
- コネクタがTransform またはTerminal の場合は、Upload Files ボタンを使用してフローにファイルをアップロードします。
Establishing a Connection
任意のREST サービスへの接続を確立するには、有効なターゲットURL が必要です。サービスURL はさまざまなHTTP メソッドをサポートでき、取得する特定のWeb サービスのアクションやデータセットに基づいてMethod を設定する必要があります。一部のサービスでは、サービスを利用するために認証やカスタムヘッダーのセットが必要になる場合もあります。 ターゲットURL がHTTPS URL の場合は、TLS Server Certificate をサーバーを識別する公開鍵証明書に設定します。ターゲットエンドポイントを暗黙的に信頼するには、フィールドをAny Certificate に設定します。
Authenticating
REST コネクタはいくつかの認証タイプをサポートしており、各タイプにはそれぞれの要件があります：- Basic（プレーンテキスト）、Digest（暗号化）、NTLM では、ユーザー名とパスワードによる認証が必要です。これらの認証情報は、リクエスト内のヘッダーとしてREST サービスに供給されます。
- OAuth 認証では、REST サービスのWeb ポータルまたは開発コンソールでのアプリ登録が必要です。アプリ登録に含めるCallback URL は、 のUI に表示されます。REST サービスに該当するGrant Type を選択し、REST サービスのWeb ポータルまたは開発コンソールに表示される詳細から残りの設定を指定します。次に、Get New Access Token をクリックして、サービスとやり取りするために必要なトークンを取得します。最初のトークンが取得されると、アプリケーションは有効期限が近づくとトークンを更新します。
- Bearer Token 認証では、サービスのWeb ポータルまたは開発コンソールからのトークンが必要です。
- Amazon に対して認証するためのAWS Signature 認証では、Amazon が提供する設定の認証情報（Access Key、Secret Key など）が必要です。
Testing Request Configurations
フローに送信されるメッセージやトランザクションを作成せずに、いつでも現在の設定をテストできます。REST Details タブでTest をクリックします。次の画像は、成功したテストのResponse Body の結果を示しています。
- Response Body：サーバーから返された形式でREST リクエストの出力を表示します。
- Response Headers：サーバーから返された応答に含まれていた応答ヘッダーを表示します。
- Message Headers：テストの出力に含まれていたメッセージヘッダーを表示します。
- Log：テストログを表示します。
Body Types
コネクタのRequest Details タブを使用して、ボディの構成方法と供給する情報の種類を指定します。次のリストでは、各オプションについてより詳しく説明します。- none：REST リクエストとともにボディは供給されません。
- form-data：ボディは名前と値のペア（フィールド）のセットとして供給されます。Name の横にあるドロップダウンリストを使用して、フィールドタイプを選択します。
- Static：Name とValue の両方を供給します。
- XML：UI でName を供給します。Value は、コネクタが処理する入力ファイルから動的に読み取られます。詳しくは、Dynamic Form Dataを参照してください。
- File：各コネクタは、1つのボディフィールドをFile に設定できます。これにより、入力ファイルがリクエストのボディで送信されます。コネクタが入力ファイル自体をフォームデータとして使用するため、Value フィールドはグレーアウトされます。
Note：File オプションは、動的リクエストや他のファイルリクエストと互換性がありません。このオプションを使用する場合は、静的フィールドとのみ組み合わせることができます。 - Header：Value フィールドを使用して、ボディのために入力メッセージから読み取るヘッダーを指定します。
- Script：供給されたValue はScript としてレンダリングされ、結果の値がリクエストボディで使用されます。
- x-www-urlencoded：ボディはform-data と同じ方法で構成されます。ただし、名前と値のペアはマルチパートフォームデータではなく、URL クエリ文字列としてエンコードされます。
- raw：ボディは、コネクタが処理する入力ファイルの内容に設定されます。ドロップダウンを使用するか、Header セクションでカスタムヘッダーとして指定して、ボディのContent Type を選択します。
Static Requests
完全に静的なコンテンツを持つREST リクエスト（HTTP GET メソッドを使用するリクエストなど）は、リクエストのコンテンツがコネクタのUI で完全に設定されるため、入力ファイルを必要としません。Header セクションにカスタムヘッダーとして、またはBody セクションにフォームデータとして、必要な名前と値のペアを追加するだけです。 Receive Automation が有効な場合、静的リクエストはスケジュールに従って自動的に送信できます。各リクエストへの応答は、出力フォルダに保存されるか、フロー内の次のコネクタに渡されます。 Send Automation が有効な場合、コネクタの入力フォルダに到着したファイルも静的リクエストをトリガーします。入力ファイルの内容は無視され、UI の設定に従ってリクエストが送信されます。Dynamic Requests
REST リクエストは、コネクタの入力フォルダに到着したファイルのデータで動的に設定できます。Raw Input Data
リクエストのBody Type をraw に設定すると、入力ファイルの内容がREST リクエストのボディとして送信されます。
Content Type ドロップダウンを使用して、データの特定のコンテンツタイプを設定します。必要なコンテンツタイプが一覧にない場合は、Header セクションに Content-Type ヘッダーを追加できます。
Dynamic Form Data
リクエストのBody Type をform-data またはx-www-urlencoded に設定すると、コネクタは入力ファイルから特定の値を探してリクエストを設定します。XML に設定された各名前と値のペアについて、コネクタは入力ファイルをスキャンして、フィールド名と同じ名前を共有し、次に示す特定のXML 構造を使用するXML 要素を探します：
CustomerID という名前の動的フィールドがあり、入力ファイルに次に示すXML がある場合、REST コネクタはCustomerID フィールドの値を12354 に設定します。
Dynamic Templates with XML Map
REST コネクタと組み合わせてXML Map コネクタを使用すると、他のXML データ構造から動的リクエストを簡単に構築できます。XML Map コネクタは、カスタムXML 構造を、REST コネクタが期待するXML 構造に変換します。 まず、リクエストに含めるべき動的（および静的）なBody フィールドのセットでREST コネクタを設定します。次に、 フローでREST コネクタにXML Map コネクタを接続し、フローの変更を保存します。これにより、XML Map コネクタは、REST コネクタが受信する入力ファイルでどのフィールドを期待しているかを検出できるようになります。 その後、XML Map コネクタ内で、Destination File ドロップダウンにREST リクエストスキーマが含まれます。これをDestination として選択し、Source File をカスタムXML 構造に設定します。これによりXML Map のMapping Editor が設定され、REST リクエストに含める必要があるデータをソース構造からデスティネーション構造にドラッグアンドドロップできます。マッピングが完了すると、XML Map コネクタは、ソースファイルに一致するファイルを有効なREST リクエスト構造に自動的に変換します。 XML Map コネクタの使用に関する詳細については、XML Map コネクタのドキュメントを参照してください。URL
コネクタ設定ペインのAdvanced tabでAllow Script in URL を選択すると、Script の式を評価して、URL として動的な文字列を生成できます。例えば、次のURL には日付と時刻が含まれます：http://myendpoint.com/api?day=[_ | now('yyyyMMdd')]
次のURL には、送信オートメーションを通じてトリガーされるクエリのために、受信メッセージのヘッダーが含まれます：
http://myendpoint.com/api?customer=[_message.header:customerid]
最後に、次のURL は、最後のクエリの時刻から現在のタイムスタンプまでの動的な日付範囲を使用し、最初のクエリにはデフォルトのタイムスタンプを使用します：
http://myendpoint.com/api?DateFrom=[_connector.lastruntimestamp | def('2025-01-01T00:00:00-04:00')]&DateTo=[_connector.currenttimestamp]
Headers
コネクタ設定ペインのAdvanced tabでAllow Script in Headers を選択すると、Script の式を評価して、ヘッダー値として動的な文字列を生成できます。例えば、次のヘッダーには日付と時刻が含まれます：Timestamp [_ | now('yyyyMMdd')]
次のヘッダーには、送信オートメーションを通じてトリガーされるクエリのために、顧客Id が含まれます：
Customer [_message.header:customerid]
Response Event
REST コネクタでレスポンスイベントを使用すると、サーバーから受信した応答（ボディ、ヘッダー、クッキーなどを含む）とやり取りし、コネクタが生成する出力メッセージを拡充できます。Response イベントでは、次の特別なアイテムを使用できます。
Response Event Example
このスクリプトは、REST 呼び出しから受信したJSON 応答を読み取り、JSON に含まれるアクセストークンを解析し、それをREST コネクタが作成する出力メッセージのヘッダーとして追加します：_response.body を介してアクセスされ、jsonDOMGet オペレーションのtext 属性に設定されます。jsonDOMGet の他の属性も設定されます。例えば、応答ボディ内の目的のトークンへのjsonpath を持つmap 属性などです。
2 jsonDOMGet オペレーションが呼び出されます。トークンが応答のJSON ボディ内で見つかると、_message.header:access_token 構文を介して、REST コネクタの出力メッセージにメッセージヘッダーとして追加されます。トークンが見つからない場合、access_token ヘッダーの値は静的な文字列 Token not found! に設定されます。
REST コネクタからのメッセージの出力メッセージ詳細を表示すると、 ではその結果が次のように表示されます：
