API 觸發條件

API 觸發條件可用於直接叫用整合項目的執行作業。

在整合服務中設定 API 觸發條件後，您就能執行下列操作：

• 使用觸發條件專屬的輸入和輸出變數，設定要求和回應酬載。
• 產生及查看整合的 OpenAPI 規格 (OAS)。
• 同步或非同步叫用整合功能。

如要瞭解如何開始使用 API 觸發程序，請參閱 API 履行教學課程。本教學課程會說明如何建立整合功能，並使用 API 觸發條件接收 API 要求，以擷取顧客資訊。

新增 API 觸發條件

如要為整合作業新增 API 觸發條件，請按照下列步驟操作：

1. 前往 Google Cloud 控制台的「Application Integration」頁面。

   前往 Application Integration

2. 在導覽選單中，按一下「整合」

   系統隨即會顯示「整合清單」頁面，列出 Google Cloud 專案中可用的所有整合功能。

3. 選取現有整合，或按一下「建立整合」建立新整合。

   如要建立新的整合項目：

   1. 在「建立整合」窗格中輸入名稱和說明。
   2. 選取整合作業的區域。
      注意：「區域」下拉式選單只會列出 Google Cloud 專案中佈建的區域。如要佈建新區域，請按一下「啟用區域」。詳情請參閱「啟用新地區」。
   3. 選取整合的服務帳戶。如要變更或更新整合的服務帳戶詳細資料，請隨時前往整合工具列的「整合摘要」窗格。
      注意：只有在您為所選區域啟用整合控管功能時，系統才會顯示選取服務帳戶的選項。
   4. 點選「建立」。

   新建立的整合作業會在整合編輯器中開啟。

4. 在整合服務編輯器的導覽列中，按一下「觸發條件」，即可查看可用觸發條件的清單。
5. 按一下「API 觸發條件」元素，並放置到設計工具中。

設定 API 觸發條件

如要設定 API 觸發條件，請在整合服務編輯器中按一下「API trigger」(API 觸發條件) 元素。系統會顯示 API 觸發條件設定窗格，其中包含下列欄位：

• 標籤：整合服務中顯示的 API 觸發條件名稱。您可以將標籤改為所選名稱。
• 附註：您可以為 API 觸發條件新增附註，提供觸發條件的額外資訊。
• 觸發條件 ID：指派給 API 觸發條件的專屬 ID，格式為 api_trigger/TRIGGER_NAME。
  注意：整合服務中可以有多個 API 觸發條件。每個 API 觸發條件都會指派專屬的「觸發條件 ID」。
• 輸入變數：觸發特定輸入變數，可用於設定 API 觸發條件的要求酬載。
  • 如要新增或移除 API 觸發條件的現有整合變數，請按一下「修改」，然後從「API 觸發條件輸入變數」窗格中選取所需變數。
  • 如要為所選 API 觸發條件新增變數，請按一下「修改」，然後從「API 觸發條件輸入變數」窗格選取「+ 新增變數」。如要瞭解支援的資料類型，請參閱支援的變數資料類型。
• 輸出變數：觸發特定輸出變數，可用於設定 API 觸發條件的回應酬載。
  • 如要新增或移除 API 觸發條件的現有整合變數，請按一下「修改」，然後從「API 觸發條件輸出變數」窗格中選取所需變數。
  • 如要為所選 API 觸發條件新增變數，請按一下「修改」，然後從「API 觸發條件輸出變數」窗格中選取「+ 新增變數」。如要瞭解支援的資料類型，請參閱支援的變數資料類型。
注意：您可以從「變數」窗格和 API 觸發條件設定窗格建立輸入和輸出變數。
• Application Integration 會自動將從 API 觸發條件設定窗格建立的變數，新增至該特定觸發條件做為輸入或輸出變數。
• 您可以手動將一個 API 觸發程序的變數新增至另一個，做為輸入或輸出變數。
• 根據預設，整合項目中的所有元素都可以存取從「變數」窗格建立的變數。
• 變更變數的變數類型，會影響整合項目中所有使用該變數的元素。

查看 API 觸發程序的 OpenAPI 規格

Application Integration 可動態產生並查看已發布整合項目的 OpenAPI 規格，這些整合項目已設定一或多個 API 觸發程序。如要瞭解如何查看 OpenAPI 規格，請參閱「查看整合項目的 OpenAPI 規格」。

使用 API 呼叫叫用 API 觸發條件

發布已設定 API 觸發條件的整合功能後，您可以使用 projects.locations.integrations.execute 方法，從任何應用程式叫用該觸發條件。這個方法會以同步模式觸發執行作業。

語法

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: TIMEOUT_SECONDS" \
    -d '{"trigger_id":"api_trigger/TRIGGER_NAME"}' \
    "https://LOCATION-integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/integrations/-:execute"

更改下列內容：

• TIMEOUT_SECONDS：API 呼叫的逾時時間 (以秒為單位)。根據預設，逾時時限為 120 秒。如需預先定義的要求參數集清單，請參閱「系統參數」。
• TRIGGER_NAME：整合中的 API 觸發條件名稱。
• PROJECT_ID： Google Cloud 專案的 ID。
• LOCATION： Google Cloud 專案的位置。

範例

下列範例會在 us-east1 地區中叫用整合，其中包含 demo-project Google Cloud 專案中的 test_API_1 API 觸發程序：

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)"
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: 300"
    -d '{"trigger_id":"api_trigger/test_API_1"}' \
    "https://us-east1-integrations.googleapis.com/v1/projects/demo-project/locations/us-central1/integrations/-:execute"

注意事項

使用 API 觸發條件時，所有輸入變數的累積大小上限為 8 MB。如果大小超過 8 MB，Application Integration 就不會執行整合作業，且您會收到錯誤訊息。

配額與限制

如要瞭解配額和限制，請參閱「配額與限制」。

後續步驟

• 瞭解所有工作和觸發條件。
• 瞭解如何測試及發布整合項目。
• 瞭解如何 處理錯誤。
• 瞭解整合執行記錄。