お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

早期アクセス

この機能はすべてのユーザーに対して有効になっているわけではありません。お試しになりたい場合は、サポートチームにメールで早期アクセスをお申し込みください。

主な機能

• REST API要求をGET、POST、PUT、またはDELETEメソッドを使用して送信できます。

• 要求にパラメーター、ヘッダー、および本文コンテンツを含めることができます。

• 実行時に値を動的に渡すには、変数を使用します。

• API応答を解析して特定のデータを抽出し、ワークフローでさらに使用できます。
  

APIの作成 

QntrlでREST API設定を作成するには、次の手順を実行します。

1. （［設定］ →［WEB SERVICES］→［Outbound］→［REST］に移動し、クリックします。

2. 右上の［APIを作成］をクリックします。

3. 左サイドバーにAPIの名前を入力します。

4. HTTPメソッド（GET、POST、PUT、またはDELETE）を選択します。

5. 要求の送信先サービスのAPI URL（エンドポイント）を入力します 。
   

6. ［接続を有効にする］（チェックボックス）：このチェックボックスを選択すると、DRE接続経由で要求が送信されます。
• 選択すると、利用可能な接続のドロップダウンが表示されます。
• 既存の接続を選択するか、［新しい接続を作成］します。
• 接続ステータスは色インジケーターで表示されます。
  
1. 緑は接続が有効であることを示します。
2. 赤は接続が無効であることを示します。
   

要求の設定 

すべてのセクション（クエリパラメーター、ヘッダー、本文）で、次の形式の静的値または動的値を使用できます。

• {{variableName}}：実行時の値に使用します。
• ${configstore-name}：Config Storeの値を使用します。
• 直接入力したリテラル値。
  

フィールドを追加するには+アイコンを使用し、必要に応じて–で削除します。

1. クエリパラメーター：API URLに追加するキーと値のペアを定義します。
   

• キー：クエリパラメーターの名前です。

• 値：上記の形式に基づいて入力します。

2. ヘッダー：要求に必要なHTTPヘッダーを設定します。

• キー：ヘッダー名（例：Authorization）

• 値：上記の形式に基づいて入力します。

3. ボディ（POST & PUTのみ）：形式を選択し、データを入力します。

• なし：要求にボディが不要な場合に選択します。

• form-data：キーと値を入力します。

• x-www-form-urlencoded：キーと値を入力します。

• Raw：複雑なペイロードには、テキスト、JSON、XMLを使用できます。

4. 変数値を使用したAPIのテスト：更新アイコンを使用して、利用可能な変数を読み込みます。API要求をテストするには、各変数にサンプル値を入力します。保存する前に設定を確認できます。要求の送信後、［レスポンス］タブでテストレスポンスを確認できます。

• テスト機能は検証目的のみであり、実際に保存された設定には影響しません。
  

• 要求設定には、最大20件のキーと値のペアを追加できます。

• レスポンスパーサーでは、最大20件のJSONパスを定義できます。
  

REST要求での変数の使用  

{{variableName}}構文を使用して、要求設定内の任意の場所に変数を挿入できます。

• 静的な値：UIで手動入力します（［変数値を使用したAPIのテスト］から）。

• 動的な値：スクリプトまたはCodexを使用して実行時に渡されます。

Codexから実行する場合は、変数をJSONオブジェクトとして指定します。

{
'jobId': '1123',
'メール': 'john.doe@swerio.com'
} 

クエリーパラメーター、ヘッダー、ボディ全体で、プレースホルダー{{jobId}}と{{メール}}がこれらの値に置き換えられます。

レスポンスパーサー 

実行後、レスポンスパーサーを使用して、JSONレスポンスから特定のデータを抽出します。

• Qntrlによりレスポンスが自動的にフィルターされ、よく使用されるJSONパスが候補として表示されます。

• 候補の中から、パスの横にある［追加］をクリックし、名前を付けて［保存］をクリックすると保存できます。

• 必要なデータを抽出するために、複数の項目を追加できます。

      

抽出された値は、次回の実行時に適用済みレスポンスとして表示され、元の完全なレスポンスとともに表示されます。

送信REST要求またはレスポンスを変更するスクリプト 

プレスクリプト  

function beforeSend() { try { var queryParams = webservice.outboundREST.getQueryParameter(); console.log('Query parameters ' + queryParams); // Add a new query parameter. var timestamp = new Date().toISOString(); webservice.outboundREST.addQueryParameter('timestamp', timestamp); // Replace variable values. var variables = {}; variables['user_id'] = '21499000000115251'; webservice.outboundREST.replaceVariableValues(variables); // Add a custom header webservice.outboundREST.addHeader('x-tracking-id', 'track-' + Date.now()); console.log('Modified query params --> ' + webservice.outboundREST.getQueryParameter()); console.log('Modified headers --> ' + webservice.outboundREST.getHeader()); } catch (e) { console.log('Error in beforeSend: ' + e.message); webservice.outboundREST.setResponseCode(500); } }   

ポストスクリプト  

• レスポンスコード、ヘッダー、データを変更できます。
• 定義済みのレスポンスパーサーはレスポンスに対して自動的に実行され、その出力は適用済みレスポンスとして利用できます。
• ポストスクリプトで変更されたレスポンスが、最終レスポンスとして取得されます。

function afterSend() { var appliedResponse = JSON.parse(webservice.outboundREST.getAppliedResponse()); console.log('appliedResponse -->' + appliedResponse); var variables = JSON.parse(webservice.outboundREST.getVariableValues()); var varJson = {}; varJson['account_id'] = appliedResponse.CRM_Account_ID; varJson['oauth_token'] = variables.oauth_token; var crmResponse = OutboundREST.executeByName('GetAccountDetailsCRM', varJson); if (!crmResponse || Object.keys(crmResponse).length === 0) { webservice.outboundREST.setResponseCode(500); webservice.outboundREST.addResponseHeader('crm_error', 'unable to fetch CRM data.'); } else { appliedResponse['crmResponse'] = crmResponse; webservice.outboundREST.setAppliedResponse(JSON.stringify(appliedResponse)); console.log('appliedResponse -->' + JSON.stringify(appliedResponse)); } }

追加設定 

1. ［接続タイムアウト］：クライアントとサーバー間の接続確立に許可される最大時間です（初期値：5秒）。
2. ［スコープ］：スコープまたは権限レベルを定義します。
   
3. ［SSL証明書の検証］：サーバーでSSL証明書の検証が必要な場合は、このオプションを有効にします。
1. 安全な通信を確保するため、Qntrlは要求の送信時にサーバーのSSL証明書を検証します。
2. 証明書は、URL内のホストとポートに基づいて取得されます。
3. 同じホストとポートに複数の証明書がある場合は、最後に追加された証明書が使用されます。
4. URLでポートが指定されていない場合、Qntrlでは既定でポート443（HTTPSの標準）が使用されます。

      

要求の保存と実行     

設定を保存するには、次の操作を行います。

• ［保存］をクリックします。APIが左サイドバーに表示されます。

• ［送信］をクリックしてAPIを実行およびテストします。この操作でもAPI設定が保存されます。

• 実行後、［レスポンス］タブで結果を確認します。

テスト結果を編集しても、実際の設定は変更されません。再テストする前に、必ず更新内容を保存してください。

OutboundREST.execute('<api_id>', <variables>);

let requestData = {};
requestData['approvalStatus'] = 'Approved';
OutboundREST.execute(31453000002078039, requestData);

OutboundREST.executeByName('api_name', <variables>);

let requestData = {};
requestData['approvalStatus'] = 'Approved';
OutboundREST.executeByName('TaskApprovalAPI', requestData);

その他の操作 

左パネルで利用可能なオプションを使用して、アウトバウンドREST APIを管理できます。

• 有効化または無効化：API名の横にある切り替えスイッチを使用して、APIを有効化または無効化します。

• 名前の変更または削除：APIの横にある［その他の操作（...）］アイコンをクリックし、必要に応じて［名前の変更］または［削除］を選択します。