開始使用 Application Integration 和 Apigee Proxy 整合目標

公告：Application Integration 現已開放 Google Cloud 專案使用。所有已啟用 Apigee Integrations 加購項目的 Apigee 訂閱使用者，現在都會免費轉介至應用程式整合服務。瞭解詳情

本教學課程將說明如何使用 Apigee Proxy 精靈，建立具有 整合目標的 Proxy。Proxy 會利用現有整合項目中的 API 觸發條件參照，啟動整合程序中的步驟序列。

以下步驟說明如何設定整合目標 Proxy，以便在 Proxy 呼叫時順利執行整合作業。

事前準備

• 確認您的 Apigee 登入憑證和機構詳細資料。您必須提供這項資訊，才能在 Apigee UI 中存取「Application Integration」功能和 Proxy 精靈。
• 建立並發布整合，其中包含API 觸發條件和至少一個工作。
  • 如果您尚未建立使用 API 觸發條件的整合，請按照「 擷取 API 酬載並傳送電子郵件」一節中的步驟操作。
  • 請記下您建立的整合項目名稱，或您要使用的現有整合項目名稱，因為後續步驟會用到這個名稱。
• 在建立 Apigee 機構的 Google Cloud 專案中建立 Google 服務帳戶，然後執行下列操作：
  • 將 Application Integration 叫用者角色 (roles/integrations.applicationIntegrationInvokerRole) 指派給服務帳戶。如要瞭解預先定義的應用程式整合角色，請參閱「預先定義的 IAM 角色」。
  • 允許您的使用者帳戶 (實體) 使用 iam.serviceAccounts.actAs 權限，將服務帳戶連結至資源。如要瞭解服務帳戶權限，請參閱「服務帳戶驗證的角色 」。

  您必須在部署 API 代理時提供這個服務帳戶。

• 如果您想不受任何限制地使用應用程式整合功能，可以付費購買整合功能。應用程式整合功能可做為訂閱方案的加購服務。如果您已購買應用程式整合授權，並想為 Google Cloud 專案或 Apigee 機構啟用授權，請洽詢 Apigee 支援團隊。不過，如果您想購買應用程式整合授權，請與 Apigee 業務團隊聯絡。啟用應用程式整合功能後，請執行下列工作：
  1. 啟用下列 API：
     • Apigee API (apigee.googleapis.com)
     • Application Integration API (integrations.googleapis.com)
     • Secret Manager API (secretmanager.googleapis.com)
     • Connectors API (connectors.googleapis.com)

     如要瞭解如何啟用 API，請參閱「啟用服務」。

  2. 為您的 Apigee 機構啟用整合和連接器外掛程式。

     • 如果您要建立新的組織來用於整合，請執行下列指令：

       curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" -d '{"name":"${ORG_ID}", "analyticsRegion":"us-west1", "authorized_network":"${NETWORK_ID}", "runtimeType":"CLOUD", "runtimeDatabaseEncryptionKeyName":"${ENCRYPTION_KEY_NAME}", "addonsConfig": {"integrationConfig": {"enabled": true}, "connectorsPlatformConfig":{"enabled":true}}}' "https://apigee.googleapis.com/v1/organizations?parent=projects/${PROJECT_ID}"

     • 如果您使用的是現有機構，請執行下列指令：

       curl -H "Authorization: Bearer $TOKEN" -H "content-type:application/json" "https://apigee.googleapis.com/v1/organizations/${ORG_ID}:setAddons" -XPOST -d '{"addonsConfig":{"integrationConfig":{"enabled":true},"connectorsPlatformConfig":{"enabled":true}}}'

  3. 使用下列指令，確認是否已成功啟用外掛程式：

     curl -H "Authorization: Bearer $TOKEN"  -H "content-type:application/json" "https://apigee.googleapis.com/v1/organizations/${ORG_ID}"

     執行指令後，畫面上應會顯示類似以下的訊息：

     {
       "name": "Test....",
       "createdAt": "1615483867669",
       "lastModifiedAt": "1615483873468",
       …...
       "addonsConfig": {
         "integrationConfig": {
           "enabled": true,
         "connectorsPlatformConfig": {
           "enabled": true
         }
       }
       }

     注意：

     • 執行外掛程式指令時，系統會覆寫所有現有的外掛程式。因此，如果您有任何現有的外掛程式，請將這些外掛程式納入外掛程式指令。
     • 停用外掛程式後，系統會刪除該外掛程式 (功能) 的所有設定。舉例來說，如果停用「整合」外掛程式，系統會刪除所有整合項目。
  4. 將下列 IAM 角色指派給預設的 Apigee 服務帳戶([e-mail])：
     • Application Integration 叫用者 (roles/integrations.applicationIntegrationInvokerRole)

     如要進一步瞭解如何為服務帳戶授予其他角色或權限，請參閱「授予、變更及撤銷存取權」一文。

建立應用程式整合目標 Proxy

如要在 Apigee UI 中建立整合目標 Proxy，請按照下列步驟操作：

1. 前往 Apigee UI 並登入帳戶。
2. 使用使用者介面左上角的下拉式選單，選取您的機構。
3. 按一下主檢視畫面中的「API Proxy」。

   您也可以在左側導覽選單中依序選取「Develop」>「API Proxies」。

4. 在「環境」下拉式清單中，選取要建立新 API 代理程式的環境。
5. 按一下「建立新項目」。
6. 從顯示的 Proxy 類型中選取「Integration target」。

   「Create Proxy」(建立 Proxy) 精靈會隨即啟動。

7. 在「Proxy details」設定頁面中提供下列詳細資料：
   • 名稱：輸入 Proxy 的名稱。

     代理程名稱可包含英數字元、破折號和底線。

   • Base Path：系統會根據 Proxy 名稱自動填入這個值。

     Base Path 是用於向 API 提出要求的網址的一部分。Apigee 會使用網址比對並轉送傳入的要求至適當的 API Proxy。

   • 說明：(選填) 輸入 Proxy 的簡短說明。

     例如 Proxy test for Application Integration。

   • 整合區域：從下拉式清單中選取整合區域。
   • 整合目標：從下拉式清單中選取整合目標的名稱。請注意，系統會根據所選整合區域填入整合目標清單。
   • 觸發條件：從下拉式清單中選取與整合相關聯的 API 觸發條件。
   • 端點類型：選取「Sync」。
8. 按一下「下一步」。
9. 在「常見政策」設定頁面中，保留預設選項，然後按一下「下一步」。
10. 在「Summary」頁面中，按一下「Create」。

    已成功建立整合目標 Proxy。

部署 Proxy

請按照下列步驟部署新建立的 Proxy：

1. 在 Apigee UI 中，依序選取「Develop」>「API Proxies」。

   使用者介面會顯示 API 代理程式清單及其部署狀態。

2. 在「Environment」下拉式清單中，選取要部署 API 代理程式的環境。

3. 按一下要部署的最近建立的 Proxy。根據預設，使用者介面會顯示「總覽」頁面。

4. 如要部署變更，請先按一下「Deploy」，顯示「Deploy」對話方塊。
5. 輸入下列內容：
   • 修訂版本：要部署的 Proxy 修訂版本號碼。
   • 環境：要部署 Proxy 的環境。
   • 服務帳戶：為 Proxy 建立的服務帳戶。
6. 按一下 [Deploy] (部署)。

UI 會開始部署所選修訂版本的程序。代理程式部署作業最多可能需要一分鐘才能完成。

代理程式部署完成後，「Deployments」部分的「Status」欄會顯示綠色圖示，表示已部署代理程式的修訂版本 1。

注意：在 Proxy 的 Set Integration Request 政策定義中，沒有明確的 Authentication 元素。Apigee 會自動將驗證權杖新增至要求。

如要讓「Set Integration Request」政策順利驗證，您必須使用具備執行整合所需 IAM 角色的服務帳戶，部署整合目標。如要進一步瞭解如何部署 API Proxy，請參閱「在 Apigee 上部署」。

測試整合目標 Proxy

在終端機視窗中執行下列指令，叫用 Proxy 並觸發整合：

curl -v https://YOUR_ENV_GROUP_HOSTNAME/PROXY_NAME

其中 YOUR_ENV_GROUP_HOSTNAME 是環境群組的主機名稱，其中包含 Proxy 部署的環境。

例如：

curl -v https://my-org-prod.hybrid.e2e.apigeeks.net/my-proxy

如要確認整合功能是透過叫用 Proxy 觸發，請按照下列步驟操作：

1. 開啟 Apigee UI。
2. 依序點選「Develop」>「Integrations」。
3. 搜尋或選取在上述步驟中建立的整合項目名稱，然後按一下整合項目名稱。
4. 按一下「Logs」。
5. 確認系統是否有針對觸發的整合作業建立執行記錄。如要查看記錄詳細資料，請按一下資料列展開執行詳細資料。

更新 Proxy 要求酬載 (選用)

請按照下列步驟更新 Proxy 要求酬載：

1. 在 Apigee UI 中，選取左側導覽選單中的「Develop」>「API Proxies」。
2. 按一下新建立的 Proxy。

   根據預設，使用者介面會在 Proxy 編輯器中顯示該 Proxy 的「總覽」分頁。

3. 按一下「開發」分頁標籤。
4. 在「Navigator」窗格中，選取「Policies」標題下方的「Set Integration Request」。
5. 取消註解 <Parameters> 模塊，然後輸入參數詳細資料。

   如要指定個別參數，請使用 <Parameter> 元素。如要指定參數陣列，請使用 <ParameterArray> 元素。

   注意：為簡單起見，本教學課程會保留 Parameters 區塊的註解。 應用程式整合支援多個參數，可在「Set Integration Request」政策中傳遞。如需更多資訊和範例，請參閱 SetIntegrationRequest 政策。
6. 按一下 [儲存]。

後續步驟

探索整合設計工具版面配置，並瞭解「所有概念」一文中所述的各種整合概念。