ユーザー定義資格情報タイプの使用方法

 メモ：   この記事は、Web サービス データアクション統合に適用されます。

Web サービス データ アクションの統合を追加するときに、資格情報の種類を選択できます。 基本認証、ユーザー定義、またはユーザー定義 (OAuth)。 詳細については、 データアクションの統合の追加 そして 資格情報の種類.

この記事では、ユーザー定義の資格情報の種類を使用する方法について説明します。 

  1. 統合を追加するときは、ユーザー定義の資格情報を構成します。

    使用している API のフィールド名と、それらのフィールド名の値を追加します。

    ユーザー定義の資格情報の構成

  2. 作成するすべてのカスタムアクションの要求で、資格情報のフィールド名を使用します。 

    次の例は、Get 天気と呼ばれるカスタムアクションの要求です。 資格 情報 は静的キーワードであり、他の Velocity マクロと一緒に使用することができます。 API_Key 資格情報構成に追加したフィールド名です。 詳細については、 データアクション用の速度マクロ。

    統合はフィールド名の値を redacts しますが、実際の値は web サービスに表示されます。 たとえば、 API_Key が12345、アクションが実行されると、web サービスに表示される requestUrlTemplate は \"https :///data/2.5/weather ? q = ロンドン &amp ; APPID = 12345 \"です。 詳細については、 カスタムアクションを作成する, カスタムアクションに構成を追加するそして 要求の構成.

    警告:  内の入力変数または出力変数の使用をエスケープするようにしてください requestTemplate, successTemplate、または requestUrlTemplate. 特殊文字を使用して変数を適切にエスケープしないと、実行時にデータアクションが失敗します。
    • 使用する esc.jsonString JSON本体内の文字列をエスケープします。

      詳細については、「esc.jsonString」セクションを参照してください データアクション用の速度マクロ.

    • 使用する esc.url（） または urlTool.optionalQueryParam（） のパスまたはクエリパラメータを適切にエスケープするには requestUrlTemplate または requestTemplate 使用している場合 x-www.form-urlencoded 値。

      詳細については、「String-escaping ライブラリセクションを参照してください。 データアクション用の速度マクロ.

    エスケープはJSONコンテキスト固有であるため、次の例では意図的にエスケープを示していません。

    {
  "requestUrlTemplate": "https://api.openweathermap.org/data/2.5/weather?q=London&APPID=${credentials.API_Key}",
  "requestType": "GET",
  "headers": {},
  "requestTemplate": "${input.rawRequest}"
}
     メモ：   カスタムアクションをテストすると、統合 redacts は任意の認証情報を使用します。 詳細については、 カスタムアクションをテストする.

統合について詳しくは、以下を参照してください。 Web サービス データアクションの統合について。