查看 Application Integration 支援的連接器。

API 觸發事件

API 觸發條件可用於直接叫用整合作業。

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

如要開始使用 API 觸發事件，請參閱 API 執行結果教學課程。本教學課程將說明如何透過 API 觸發條件建立整合，以便接收用於擷取顧客資訊的 API 要求。

新增 API 觸發條件

如要在整合中新增 API 觸發條件，請執行下列步驟：
  1. 前往 Google Cloud 控制台的「Application Integration」頁面。

    前往「應用程式整合」

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

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

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

    如果您要建立新的整合功能：

    1. 在「Create Integration」窗格中輸入名稱和說明。
    2. 選取整合作業的區域。
    3. 選取要用於整合的服務帳戶。您隨時可以透過整合工具列的 「整合摘要」窗格，變更或更新整合作業的服務帳戶詳細資料。
    4. 按一下 [建立]。

    新建立的整合服務會在整合服務編輯器中開啟。

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

設定 API 觸發條件

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

  • Label：整合中 API 觸發條件顯示的名稱。您可以將標籤改為所需名稱。
  • 附註：您可以為 API 觸發條件新增附註，提供觸發條件相關的其他資訊。
  • 觸發條件 ID：指派給 API 觸發條件的專屬 ID，格式為 api_trigger/TRIGGER_NAME。
  • 輸入變數：觸發特定輸入變數，可用於設定 API 觸發事件的要求酬載。
    • 如要新增或移除現有的整合變數至 API 觸發條件，請按一下「修改」，然後從「API 觸發條件輸入變數」窗格中選取必要變數。
    • 如要新增變數，特別是針對所選 API 觸發條件，請按一下「修改」，然後在「API 觸發條件輸入變數」窗格中選取「+ 新增變數」。如要瞭解支援的資料類型，請參閱「支援的變數資料類型」。
  • 輸出變數：觸發特定輸出變數，可用於設定 API 觸發事件的回應酬載。
    • 如要新增或移除現有的整合變數至 API 觸發條件，請按一下「修改」，然後從「API 觸發條件輸出變數」窗格中選取所需變數。
    • 如要新增變數，特別是針對所選 API 觸發條件，請按一下「修改」，然後在「API 觸發條件輸出變數」窗格中選取「+ 新增變數」。如要瞭解支援的資料類型，請參閱「支援的變數資料類型」。

查看 API 觸發事件的 OpenAPI 規格

應用程式整合功能可動態產生及查看已發布的整合項目 OpenAPI 規格，這些整合項目會使用一或多個 API 觸發事件進行設定。如要瞭解如何查看 OpenAPI 規格，請參閱「查看整合項目的 OpenAPI 規格」。

使用 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，應用程式整合功能就不會執行整合作業，並會傳回錯誤訊息。

配額與限制

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

後續步驟