查看 Application Integration 支援的連接器。

建立自訂連接器

本頁說明如何建立自訂連接器。如要瞭解自訂連接器，請參閱自訂連接器。

如要使用自訂連結器建立與後端的連線，請執行下列工作：

  1. 建立自訂連接器：在這項工作中，您將提供端點的 OpenAPI 規格，定義 Application Integration 與端點 (後端) 之間的合約。目前僅支援 OpenAPI 3.0 版和所有次要版本。指定規格是一次性活動。
  2. 建立自訂連接器連線：在這項工作中，您將設定後端的連線詳細資料，例如主機名稱和驗證。您可以視需要為特定自訂連接器建立多個連線。

如要瞭解連接器和連線的差異，請參閱「連接器與連線的比較」。

事前準備

建立自訂連接器

如後端連線情境所述，自訂連接器可採用下列任一連線模式：

  • 直接連線至後端的公開端點。
  • 透過中介公開端點間接連線至後端。

這兩種模式的自訂連接器建立步驟略有不同。

使用直接連線建立

如要建立自訂連結器，直接連線至後端的端點，請按照下列步驟操作：

控制台

  1. 在 Console 中，前往「Application Integration」>「Custom connectors」頁面，然後選取或建立 Google Cloud 專案。

    前往「Custom connectors」(自訂連接器) 頁面

  2. 按一下「建立新項目」，開啟「建立自訂連接器」頁面。
  3. 在「連接器詳細資料」部分，設定下列欄位：
    1. 連接器名稱：輸入連接器名稱。
    2. 顯示名稱：輸入連接器的顯示名稱。
    3. 說明：輸入說明。
    4. 服務帳戶：選取具備必要角色的服務帳戶。
    5. 標誌：將圖片上傳至 Cloud Storage 值區，即可做為連結器標誌。
  4. 點選「下一步」。
  5. 在「連接器規格」部分，設定下列欄位：
    1. 自訂連接器類型：選取自訂連接器類型。
    2. 連結器規格：輸入 Open API 規格的公開網址，或將規格檔案上傳至 Cloud Storage 值區。
  6. 查看連接器設定詳細資料，然後按一下「建立」。

如果連接器建立成功，新建立的連接器會顯示在「前往自訂連接器頁面」中，如果是新連接器，系統也會建立連接器的第一個版本。您可以在「Custom Connector details」(自訂連接器詳細資料) 頁面的「Version」(版本) 分頁中查看版本詳細資料。詳情請參閱。

但請注意，如要連線至後端，您必須為新建立的連接器建立連線。詳情請參閱「建立自訂連接器連線」。

API

下列範例指令顯示如何使用 Application Integration API 建立自訂連接器：

  1. 建立連接器。 
    curl -X POST \
-H "authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json"
-d '{"customConnectorType":"OPEN_API", \
"displayName":"CUSTOM_CONNECTOR_NAME", \
"description": "an open api based custom connector for hrms"}' \
"https://connectors.googleapis.com/v1/projects/PROJECT_ID/locations/global/customConnectors?custom_connector_id=UNIQUE_IDENTIFIER"

    取代下列項目：

    • CUSTOM_CONNECTOR_NAME：自訂連接器的名稱。
    • PROJECT_ID：您的 Google Cloud 專案 ID。
    • UNIQUE_IDENTIFIER：連接器的專屬 ID。例如 custom-connector-1。
  2. 設定自訂連接器版本。 
    curl -X POST \
-H "authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{"spec_location": "SPECIFICATION_URL",}' \
"https://connectors.googleapis.comv1/projects/PROJECT_ID/locations/global/customConnectors/openapi-customconnector/customConnectorVersions?custom_connector_version_id=VERSION_NUMBER"

    3. 取代下列項目：

    • SPECIFICATION_URL：Open API 規格網址。例如：https://petstore3.swagger.io/api/v3/openapi.json。
    • PROJECT_ID：您的 Google Cloud 專案 ID。
    • VERSION_NUMBER：連接器的版本號碼。例如：2。

透過間接連線建立

如要建立自訂連接器，透過中繼端點連線至後端，請按照下列步驟操作：

控制台

  1. 在 Console 中，前往「Application Integration」>「Custom connectors」頁面，然後選取或建立 Google Cloud 專案。

    前往「Custom connectors」(自訂連接器) 頁面

  2. 按一下「建立新項目」，開啟「建立自訂連接器」頁面。
  3. 在「連接器詳細資料」部分，設定下列欄位：
    1. 連接器名稱：輸入連接器名稱。
    2. 顯示名稱：輸入連接器的顯示名稱。
    3. 說明：輸入說明。
    4. 設定後端存取的連接器目的地：啟用這個選項。頁面會顯示其他設定區段。
    5. 服務帳戶：選取具有必要角色的服務帳戶。
    6. 標誌：將圖片上傳至 Cloud Storage 值區，即可做為連結器標誌。
  4. 點選「下一步」。
  5. 在「連接器規格」部分，設定下列欄位：
    1. 自訂連接器類型：選取自訂連接器類型。
    2. 連結器規格：輸入 Open API 規格的公開網址，或將規格檔案上傳至 Cloud Storage 值區。
  6. 點選「下一步」。
  7. 在「連接器目的地」部分，設定下列欄位：
    1. 目的地類型：選取「主機位址」。
    2. 主機：輸入中介服務的執行所在主機名稱，並加入 http:// 或 https:// 配置。
    3. 「Port」(通訊埠)：輸入中介服務的通訊埠編號。
  8. 點選「下一步」。
  9. 在「連結器驗證」部分，選取中介服務的驗證類型，然後按照提示輸入相應詳細資料。這個步驟是為了設定從 Application Integration 到中介服務的驗證。

    您無法在應用程式整合中，設定從中介服務到後端的驗證設定；中介服務如何向後端進行驗證，取決於中介服務本身。

    您可以使用下列驗證類型，向中介服務進行驗證：

    • 服務帳戶驗證
    • API 金鑰驗證
    • OAuth 2.0 - 用戶端憑證驗證
    • 基本驗證
    • 摘要驗證

      • 如要瞭解如何設定這些驗證類型，請參閱「設定驗證」。

    如果 API 資源的存取權不受限制，且不需要任何驗證，請選取「No Authentication」(不需驗證)。

  10. 點選「下一步」。
  11. 在「後端變數」部分，輸入要透過中介服務傳送至後端的值。您必須將值設為鍵/值組合。如要輸入鍵/值組合，請按一下「新增變數」，然後設定下列欄位：
    • 金鑰：輸入金鑰名稱。
    • 值類型：選取變數的資料類型。
    • 顯示名稱：輸入顯示名稱。
    • 位置：指定連結器要如何將變數傳送至中介服務。可用選項包括 Header、Request payload 和 Query parameter。
    • (選用) 選取 Required，指定變數為必要變數。
  12. 點選「下一步」。
  13. 查看連接器設定詳細資料，然後按一下「建立」。

如果連接器建立成功，新建立的連接器會顯示在自訂連接器頁面中，如果是新連接器，系統也會建立連接器的第一個版本。您可以在「Custom Connector details」(自訂連接器詳細資料) 頁面的「Version」(版本) 分頁中查看版本詳細資料。如要瞭解如何建立及編輯自訂連接器版本，請參閱「管理自訂連接器版本」一文。

但請注意，如要連線至後端，您必須為新建立的連接器建立連線。詳情請參閱「建立自訂連接器連線」。

設定驗證機制

根據要使用的驗證方式輸入詳細資料。

  • 服務帳戶驗證

    選取這個選項，即可使用 Google Cloud 服務帳戶進行驗證。請確認您已為服務帳戶提供驗證所需的相關 IAM 角色和權限。

    • 範圍：從下拉式選單中選取所需的 OAuth 2.0 範圍。詳情請參閱存取範圍。
  • API 金鑰驗證

    選取這個選項，即可使用 API 金鑰進行驗證。

    • API 金鑰：選取 API 金鑰的 Secret Manager 密鑰。
    • 密鑰版本：選取密鑰版本。
    • API 金鑰參數名稱：輸入 API 金鑰的參數名稱。API 金鑰會以鍵/值組合的形式傳送至後端伺服器。您在此輸入的值，將做為先前所選 API 金鑰的鍵名。
    • API 金鑰位置：選取要在要求中加入 API 金鑰的位置。
  • OAuth 2.0 - 用戶端憑證授權
    • 用戶端 ID：用於向中介服務驗證的用戶端 ID。
    • 用戶端密鑰：Secret Manager 密鑰，內含向中介服務驗證的用戶端密鑰。
    • 存取權杖的要求格式：從驗證伺服器擷取存取權杖時，要求中使用的格式。 選取 body 將用戶端 ID 和密鑰做為要求主體傳遞，或選取 header 將兩者做為編碼標頭傳遞。
    • 權杖要求路徑：要附加至驗證伺服器網址的要求路徑，用於擷取存取權杖網址。
  • 基本驗證
    • 使用者名稱：用於向中介服務驗證的使用者名稱。
    • 密碼：Secret Manager 密鑰，內含所提供使用者名稱的相關聯密碼。
  • 摘要驗證
    • 使用者名稱：用於向中介服務驗證的使用者名稱。
    • 密碼：Secret Manager 密鑰，內含所提供使用者名稱的相關聯密碼。

API

下列範例指令顯示如何使用 Application Integration API 建立自訂連接器：

  1. 建立連接器。 
    curl -X POST \
-H "authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json"
-d '{"customConnectorType":"OPEN_API", \
"displayName":"CUSTOM_CONNECTOR_NAME", \
"description": "an open api based custom connector for hrms"}' \
"https://connectors.googleapis.com/v1/projects/PROJECT_ID/locations/global/customConnectors?custom_connector_id=UNIQUE_IDENTIFIER"

    取代下列項目：

    • CUSTOM_CONNECTOR_NAME：自訂連接器的名稱。
    • PROJECT_ID：您的 Google Cloud 專案 ID。
    • UNIQUE_IDENTIFIER：連接器的專屬 ID。例如 custom-connector-1。
  2. 設定自訂連接器版本和驗證。 
    curl -X POST \
-H "authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{"spec_location": "SPECIFICATION_URL", \
"service_account":"test-sa", \
"enable_backend_destination_config": true, \
"auth_config": { \
"auth_type":"USER_PASSWORD", \
"auth_key": "basic", \
"user_password": { \
"username":"USERNAME", \
"password": {"secret_version":"projects/PROJECT_ID/secrets/fidelity-secret/versions/SECRET_VERSION_NUMBER"} \
}}, \
"backend_variable_templates": [{ \
"key":"authkey", \
"value_type":"SECRET", \
"display_name":"Authorization Key", \
"required":true, \
"location_type": "HEADER" \
}], \
"destination_configs":[{ \
"key":"base_url", \
"destinations": [{ \
"host":"DESTINATION_HOST_ADDRESS" \
}]} \
]}' \
"https://connectors.googleapis.com/v1/projects/PROJECT_ID/locations/global/customConnectors/facade-connector/customConnectorVersions?custom_connector_version_id=CONNECTOR_VERSION_NUMBER"

    3. 取代下列項目：

    • SPECIFICATION_URL：Open API 規格網址。例如：https://petstore3.swagger.io/api/v3/openapi.json。
    • PROJECT_ID：您的 Google Cloud 專案 ID。
    • USERNAME：用於向中介服務進行驗證的使用者名稱。
    • SECRET_VERSION_NUMBER：Secret Manager 密鑰版本號碼。例如：2。
    • DESTINATION_HOST_ADDRESS：中介服務的主機位址。例如：http://www.test.com:80。
    • CONNECTOR_VERSION_NUMBER：自訂連結器的版本號碼。例如：1。

建立自訂連接器連線

建立自訂連接器後，如要連線至後端，您必須建立自訂連接器類型的連線。以下是建立新連結的高階步驟：

  1. 按一下「新建」開啟「建立連線」頁面。
  2. 在「Location」(位置) 區段中，從「Region」(區域) 欄位選取連線位置。

    如需所有支援的地區清單，請參閱「位置」一文。

  3. 點選「下一步」。
  4. 在「連線詳細資料」部分，設定下列欄位：
    1. 連接器：從可用連接器的下拉式清單中選取自訂連接器。
    2. 連接器版本：從可用版本的下拉式清單中選取連接器版本。
    3. 在「連線名稱」欄位中，輸入連線的名稱。

      連線名稱必須符合下列條件：

      • 連線名稱可使用英文字母、數字或連字號。
      • 字母必須為小寫。
      • 連線名稱開頭須為英文字母，結尾則須為英文字母或數字。
      • 連結名稱長度不得超過 63 個字元。
    4. 視需要輸入連線的「Description」(說明)。
    5. 如要啟用雲端記錄功能，請選取「啟用雲端記錄」。
    6. 服務帳戶：選取具備必要角色的服務帳戶。
    7. 視需要設定「連線節點設定」：

      • 節點數量下限：輸入連線節點數量下限。
      • 節點數量上限：輸入連線節點數量上限。

      節點是用來處理交易的連線單位 (或備用資源)。連線處理的交易量越多，就需要越多節點；反之，處理的交易量越少，需要的節點就越少。如要瞭解節點對連接器定價的影響，請參閱「 連線節點定價」。如未輸入任何值，系統預設會將節點下限設為 2 (提高可用性)，節點上限則設為 50。

    8. (選用) 按一下「新增標籤」，以鍵/值組合的形式為連線新增標籤。
  5. 點選「下一步」。
  6. 如果連接器使用中介服務連線至後端，請按照下列步驟操作：

    在「目的地」部分，設定下列欄位：

    1. 目的地類型：選取「主機位址」。
    2. 主機：輸入中介服務的執行所在主機名稱，並加入 http:// 或 https:// 配置。
    3. 「Port」(通訊埠)：輸入中介服務的通訊埠編號。

    根據預設，目的地欄位會包含 OpenAPI 規格中的規格網址。如果有多個伺服器網址，系統會顯示第一個。

  7. 點選「下一步」。
  8. 在「Authentication」(驗證) 專區中，輸入後端的驗證詳細資料。
    • 如果您直接連線至後端，Application Integration 會提示您設定後端的驗證。
    • 如果您透過中介服務間接連線至後端，Application Integration 就不會提示您設定驗證詳細資料。建立連接器時，您應該已設定 Application Integration 與中介服務之間的驗證。您不需要設定中介服務與後端之間的驗證，中介服務可自行決定如何向後端驗證。
  9. 點選「下一步」。
  10. 查看連線設定詳細資料，然後按一下「建立」。

如果連線建立成功，系統會將連線列在「所有連線」頁面，且連線會顯示在 Application Integration 中。您可以在整合服務中透過連接器工作使用連線。

注意事項

建立自訂連接器時，請考量下列要點：

  • Application Integration 僅支援 OpenAPI 3.0 版和所有次要版本。
  • 建立自訂連接器時，系統不會驗證 Open API 規格。為自訂連接器建立連線時，Application Integration 會驗證規格，如果規格有錯誤，連線就會處於 Error 狀態。
  • Application Integration 不會區分實體和動作。因此，後端的實體和動作都會在自訂連接器中列為 Actions。
  • 如果專案已啟用 VPC Service Controls，則不支援自訂連線器。 Google Cloud
  • OpenAPI 規格端點和後端端點都應可公開存取。也就是說，您無法建立後端的私人連線。
  • Open API 規格不支援多部分媒體類型。
  • 您無法編輯自訂連接器的版本詳細資料。

配額與限制

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

後續步驟