建立自訂連接器

控制台

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

   前往「自訂連接器」頁面

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

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

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

API

下列範例指令說明如何使用應用程式整合 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"
   

請依指示取代下列項目：

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

控制台

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

   前往「自訂連接器」頁面

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

   從中介服務到後端的驗證設定無法在應用程式整合中設定；中介服務如何驗證後端，則由中介服務自行決定。

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

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

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

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

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

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

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

設定驗證機制

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

• 服務帳戶驗證

  選取這個選項，即可使用 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

下列範例指令說明如何使用應用程式整合 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"
   

請依指示取代下列項目：

• 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。