Apigee Integration スタートガイド

Apigee X のドキュメントを表示中です。
Apigee Edge のドキュメントを表示する。

このクイックスタートでは、Apigee Integration を使用してサンプルの統合を作成する方法を説明します。次の手順では、完全な統合の実行に必要なトリガー、タスク、エッジ、変数、データ マッピングを構成する方法を説明します。このクイックスタートでは、URL エンドポイントからプロダクト リストを取得し、データを使用可能な形式に変換して、生成されたリストをメールで送信します。これらはすべて統合デザイナー内で行うことができます。

始める前に

クイックスタートを開始する前に、Apigee ログイン認証情報と組織の詳細を確認します。この情報は、デザイナー内の Apigee 統合機能にアクセスするために必要です。

新しい統合を作成する

新しい統合を作成するには、次の手順を行います。

  1. Apigee UI にアクセスしてログインします。
  2. UI の左上にあるプルダウン メニューから組織を選択します。
  3. [開発] > [統合] の順にクリックします。
  4. [新規作成] をクリックします。
  5. [統合の作成] ダイアログで名前と説明を入力します。例: my-test-integration
  6. サポートされているリージョンのリストから、統合のリージョンを選択します。
  7. [作成] をクリックして統合デザイナーを開きます。

トリガーを構成する

統合を構成する一連のタスクを開始するには、トリガーが必要です。統合を開始するには、使用可能な任意のトリガーを使用できます。このクイックスタートでは、API トリガーを使用します。

API トリガーを構成するには:

  1. 統合デザイナーで、[タスク / トリガー] > [トリガー] の順に選択して、使用可能なトリガーのリストを表示します。
  2. [API トリガー] 要素を統合デザイナーにドラッグします。
  3. デザイナーで [API トリガー] 要素をクリックして、トリガー構成ペインを開きます。
  4. Apigee Integration では、トリガー [ラベル]、[トリガー名]、[トリガー ID] が自動的に入力されます。[トリガー ID] は自動生成されており、値は編集できません。ただし、[ラベル] プロパティと [トリガー名] プロパティの値を編集することはできます。

    プロパティへの変更は自動的に保存されます。

タスクを追加して構成する

タスクは、変数を入力として受け取り、出力として変数を生成する、実行可能な一連のステップです。トリガーと同様、統合では任意の使用可能なタスクが使用できます。 このクイックスタートでは、REST エンドポイントの呼び出しデータ マッピングメールの送信の各タスクを使用します。各タスクの構成の詳細は、次の手順で説明します。

REST エンドポイントの呼び出しタスクを構成する

REST エンドポイントの呼び出し タスクを構成するには:

  1. [タスク / トリガーを追加] > [タスク] の順に選択して、利用できるタスクのリストを表示します。
  2. REST エンドポイントの呼び出し 要素を統合デザイナーにドラッグします。
  3. デザイナーで [REST エンドポイントの呼び出し] 要素をクリックして、タスク構成ペインを開きます。次のプロパティ値を設定します。
    • ラベル: このタスクのカスタム名を入力します。 たとえば、「Call REST Endpoint Task」と入力します。
    • 認証: このクイックスタートでは、認証プロファイルは必要ありません。他のユースケースで認証プロファイルを使用する方法について詳しくは、Apigee 統合で認証プロファイルを作成するをご覧ください。
    • タスク入力: REST エンドポイントを呼び出すための詳細を入力します。ここに入力した情報は、REST エンドポイントの呼び出しタスクの入力として使用されます。次の情報を入力します。
      • エンドポイント ベース URL: 「https://apigee-pm4-prod.apigee.net/v1/hipsters/products」と入力します。このエンドポイントは、商品オブジェクトの配列を、それぞれ idnamedescriptionpictureprice と、categories の配列とともに返します。
      • HTTP メソッド: プルダウン リストを使用して [GET] を選択します。
      • [追加の HTTP ヘッダー]: エンドポイントへのアクセスに必要な追加のヘッダーを入力します。このクイックスタートでは、次の内容を入力します。
        • [HTTP ヘッダーキー] フィールドに「x-apikey」を入力します。
        • [] フィールドに「H7WpkpvdCAC2jSffbmKpQLVduxC6nOO9」と入力します。
    • タスク出力: REST エンドポイントの呼び出しのレスポンス データの出力を格納するために、Apigee Integration により、ここには次の 3 つの変数が入力されます。
      • responseHeader(REST エンドポイントの呼び出し): この変数は、REST エンドポイントの呼び出しタスクに関連付けられたレスポンス ヘッダーのデータを保持します。変数データの型は、String(STR)です。
      • responseBody(REST エンドポイントの呼び出し): この変数は、REST エンドポイントの呼び出しタスクに関連付けられたレスポンス本文のデータを保持します。変数データの型は、String(STR)です。
      • responseStatus(REST エンドポイントの呼び出し): この変数は、REST エンドポイントの呼び出しタスクに関連付けられたレスポンス ステータスのデータを保持します。変数データの型は、String(STR)です。
    • タスク構成ペインで変数名をクリックすると、各変数の詳細が表示されます。このクイックスタートでは、これらの変数のそれぞれについてデフォルト値のままにします。
    • 残りのフィールドには、次のデフォルト値が含まれている必要があります。
      • リダイレクトのフォロー: True
      • エラーのスロー: False
      • 失敗時に再試行する
        • 統合を同期で実行する場合: None
        • 統合が非同期で実行される場合: None

    プロパティへの変更は自動的に保存されます。

    完成した構成は、次の図のようになります。

    REST エンドポイント トリガーの呼び出し

  4. [API トリガー] 要素からエッジ接続を [REST エンドポイントの呼び出し] 要素に追加するには、[API トリガー] 要素のコントロール ポイントの上にカーソルを合わせてからクリックし、[REST エンドポイントの呼び出し] タスク要素のコントロール ポイントに線を引きます。下の画像のように、コントロール ポイントとエッジの線は黄色に変わります。

    エッジ接続を示す統合デザイナー

    エッジは、[API トリガー] から [REST エンドポイントの呼び出し] タスクへの制御フローを示しています。

データ マッピング タスクを構成する

データ マッピング タスクを構成するには:

  1. [タスク / トリガーを追加] > [タスク] の順に選択して、利用できるタスクのリストを表示します。
  2. [データ マッピング] 要素を統合デザイナーにドラッグします。
  3. デザイナーの [データ マッピング] タスクをクリックして、タスクの構成ペインを開きます。
  4. [データ マッピング エディタを開く] をクリックします。

    データ マッピング エディタを使用すると、使用可能な変換関数を使用して、入力変数を目的の出力変数にマッピングできます。出力は、他の統合タスクまたはトリガーの変数として使用できます。データを変数として渡す方法の詳細については、Apigee Integration で変数を使用するをご覧ください。

    このクイックスタートでは、次の手順を行って、responseBody(REST エンドポイントの呼び出し)を入力として使用し、マッピングを作成します。

    1. エディタの左側にある [Variables] リストから [responseBody] チップを、最初の [Input] フィールドにドラッグします。
    2. responseBody チップで [+ 関数を追加する] をクリックして、使用可能な関数のプルダウン リストを表示します。
    3. いくつかのデータ マッピング関数を適用して、入力変数のデータを変換できます。この場合、ペイロードを JSON に変換し、次にレスポンス配列を反復処理して、メール通知に必要なプロダクト名のリストを取得できます。responseBody 変数の [+ 関数を追加する] 記号をクリックし、利用可能な関数のリストを開きます。次の関数を使用します。
      • [TO_JSON()] を選択し、responseBody 文字列を JSON に変換します。
      • responseBody 変数チップの [+ 関数を追加する] 記号をもう一度クリックして、GET_PROPERTY() 関数を選択し、連結します。この関数は、JSON ペイロードからプロパティを抽出します。この関数のパラメータとして products.name プロパティに渡します。これにより、プロダクト名のみのリストが返されます。他の商品情報は含まれません。関数は次のようになります。
        responseBody(Call REST Endpoint).TO_JSON().GET_PROPERTY(products.name)
      • 関数を削除する、または取り消すには、- 記号をクリックします。これにより、直近に追加された関数が削除されます。
    4. [Output] 列の最初のフィールドをクリックして、変換されたデータの値を保持する新しい変数を作成します。次のフィールドに値を入力します。
      • 名前:JSONProdNameList」と入力します。
      • データ型: JSON
      • [Use as an output of integration] チェックボックスをオンにします。
      • [作成] をクリックして変数を作成し、ペインを閉じます。新しい JSONProdNameList 変数が、データ マッピング エディタの左側にある [Variables] リストに表示されます。
    5. Data Mapping Editor で、[X] をクリックしてマッピングを保存し、エディタを閉じます。
    6. 次の図のように、完成したマッピングが表示されます。

      完成したデータ マッピングと変数の画像

  5. [REST エンドポイントの呼び出し] 要素から [データ マッピング] 要素にエッジ接続を追加するには、[REST エンドポイントの呼び出し] 要素のコントロール ポイントの上にカーソルを合わせてからクリックし、[データ マッピング] タスク要素のコントロール ポイント線を引きます。エッジは、[REST エンドポイントの呼び出し] タスクから [データ マッピング] タスクへの制御のフローを示します。

メール送信タスクを構成する

Send Email タスクを構成するには、次のようにします。

  1. 統合デザイナーで、[タスク / トリガーを追加] > [タスク] をクリックして使用可能なタスクのリストを表示します。

    この手順では、メール送信タスクを使用します。

  2. [メールを送信] タスク要素を統合デザイナーにドラッグします。
  3. デザイナーで [メール送信] 要素をクリックして、タスクの構成ペインを開きます。次のプロパティ値を設定します。
    • 受信者: メールアドレスを入力します。このメールを使用して、統合が正常に完了していることを確認します。
    • 件名: 「Email from Apigee Integrations」と入力します。
    • メールの本文: データ マッピングタスクで先ほど作成した JSONProdNameList 変数を選択します。
    • 残りのオプションはデフォルト構成のままにします。

    プロパティへの変更は自動的に保存されます。

    完成した構成は、次の図のようになります。

    メールタスク構成ファイル

  4. [データ マッピング] 要素から [メール送信] 要素にエッジ接続を追加するには、[データ マッピング] 要素のコントロール ポイントにカーソルを合わせてからクリックし、[メール送信] タスク要素のコントロール ポイントに線を引きます。コントロール ポイントとエッジの線が黄色に変わります。エッジは、データ マッピングタスクからメール送信タスクへの制御フローを示します。

統合をテストする

新しい統合をテストするには:

  1. 統合デザイナーのツールバーで、[公開] ボタンをクリックします。統合を公開すると、ツールバーの [テスト] ボタンが有効になります。
  2. [テスト] をクリックし、[API Trigger] を選択します。
  3. [Confirm Publish and Test] ダイアログで [Publish & Test] をクリックします。

テストの詳細については、統合のテストをご覧ください。

正常に完了すると、プロダクト名のリストを含むメールがメール送信タスクで指定されたメールアドレスに送信されます。ご自身のメール クライアントでメールの受信を確認します。

統合によって送信されるメールには、次のような本文が含まれています。

["Vintage Typewriter", "Vintage Camera Lens", "Home Barista
Kit", "Terrarium", "Film Camera", "Vintage Record Player", "Metal Camping
Mug", "City Bike", "Air Plant"]

メールの内容の確認に加え、ログを調査して、特定の統合のステータスとペイロードを表示できます。ログを表示するには:

  1. 統合デザイナーのツールバーで、[ログ] をクリックします。
  2. [実行ログ] ページでは、統合の実行の試行ごとに関する詳細を確認できます。各エントリには、以下のような実行の試行の詳細が含まれます。
    • 連携名
    • 実行 ID
    • ステータス
    • 開始時刻
    • 期間
    • 統合 ID
    • トリガー ID
  3. 実行された統合の横にある展開の矢印(>)をクリックすると、展開された統合のタスクと変数のリストと、タスクのステータスと変数のペイロードが表示されます。

お疲れさまでしたこれで、Apigee Integration を使用した統合の構成とデプロイが完了しました。

次のステップ