API 觸發條件

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

在整合中設定 API 觸發條件，即可執行下列操作：

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

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

新增 API 觸發條件

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

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

   前往 Application Integration

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

   系統隨即會顯示「Integrations List」(整合清單) 頁面，列出 Google Cloud 雲端專案中所有可用的整合項目。

3. 選取現有整合項目，或按一下「Create integration」(建立整合項目) 建立新的整合項目。

   如要建立新的整合：

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

   新建立的整合項目會在整合編輯器中開啟。

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

設定 API 觸發條件

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

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

查看 API 觸發條件的 OpenAPI 規格

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

注意：本頁面著重說明如何使用 v1 API 叫用 API 觸發條件。為整合項目生成的 OpenAPI 規格可能包含其他 API 版本的定義，例如 v2。

使用 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 '{"triggerId":"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：整合項目所在的區域，例如 us-east1。

範例

下列範例會在 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 '{"triggerId":"api_trigger/test_API_1"}' \
    "https://us-east1-integrations.googleapis.com/v1/projects/demo-project/locations/us-east1/integrations/-:execute"

注意事項

使用 API 觸發條件時，所有輸入變數的累計大小上限為 8 MB。如果超過 8 MB，Application Integration 就不會執行整合，並會顯示錯誤。

配額與限制

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

後續步驟

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