建立SFTP基本連線，使用 Flow Service API

基礎連線代表來源和Adobe Experience Platform之間已驗證的連線。

本教學課程將逐步引導您完成建立基礎連線的步驟。 SFTP （安全檔案傳輸通訊協定）使用 Flow Service API.

快速入門

本指南需要您實際瞭解下列Adobe Experience Platform元件：

  • 來源：Experience Platform可讓您從各種來源擷取資料，同時使用Platform服務來建構、加標籤及增強傳入資料。
  • 沙箱：Experience Platform提供的虛擬沙箱可將單一Platform執行個體分割成個別的虛擬環境，以利開發及改進數位體驗應用程式。
重要

建議在使用擷取JSON物件時避免換行或歸位 SFTP 來源連線。 若要繞過此限制，請在每行使用單一JSON物件，並在後續檔案中使用多行。

以下小節提供成功連線至所需的其他資訊 SFTP 伺服器使用 Flow Service API。

收集必要的認證

為了 Flow Service 以連線到 SFTP，您必須提供下列連線屬性的值：

認證 說明
host 與您的關聯的名稱或IP位址 SFTP 伺服器。
port 您連線到的SFTP伺服器連線埠。 如果未提供，值會預設為 22.
username 您擁有存取許可權的使用者名稱 SFTP 伺服器。
password 您的密碼 SFTP 伺服器。
privateKeyContent Base64編碼的SSH私密金鑰內容。 OpenSSH金鑰型別必須分類為RSA或DSA。
passPhrase 如果金鑰檔案或金鑰內容受到密語保護，則用來解密私密金鑰的密語或密碼。 如果 privateKeyContent 受密碼保護，此引數需搭配私密金鑰內容的密碼短語作為值使用。
maxConcurrentConnections 此引數可讓您指定Platform在連線至您的SFTP伺服器時將建立的同時連線數目上限。 您必須將此值設定為小於SFTP設定的限制。 注意：為現有SFTP帳戶啟用此設定時，只會影響未來的資料流，而不會影響現有的資料流。
folderPath 您要提供存取權的資料夾路徑。 SFTP 來源，您可以提供資料夾路徑，以指定使用者對所選子資料夾的存取權。
connectionSpec.id 連線規格會傳回來源的聯結器屬性，包括與建立基礎連線和來源連線相關的驗證規格。 的連線規格ID SFTP 為： b7bf2577-4520-42c9-bae9-cad01560f7bc.

使用平台API

如需如何成功呼叫Platform API的詳細資訊，請參閱以下指南中的 Platform API快速入門.

建立基礎連線

基礎連線會保留您的來源和平台之間的資訊，包括來源的驗證認證、連線的目前狀態，以及您唯一的基本連線ID。 基本連線ID可讓您瀏覽和瀏覽來源內的檔案，並識別您要擷取的特定專案，包括其資料型別和格式的資訊。

此 SFTP 來源支援基本驗證和透過SSH公開金鑰的驗證。 在此步驟中，您也可以指定要提供存取權的子資料夾的路徑。

POST若要建立基本連線ID，請向 /connections 端點，同時提供 SFTP 要求引數中的驗證認證。

重要

此 SFTP 聯結器支援RSA或DSA型別的OpenSSH金鑰。 確定您的關鍵檔案內容開頭為 "-----BEGIN [RSA/DSA] PRIVATE KEY-----" 結束於 "-----END [RSA/DSA] PRIVATE KEY-----". 如果私密金鑰檔案是PPK格式檔案，請使用PuTTY工具從PPK轉換為OpenSSH格式。

API格式

POST /connections

要求

下列要求會建立 SFTP：

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d  '{
      "name": "SFTP connector with password",
      "description": "SFTP connector password",
      "auth": {
          "specName": "Basic Authentication for sftp",
          "params": {
              "host": "{HOST}",
              "port": 22,
              "userName": "{USERNAME}",
              "password": "{PASSWORD}",
              "maxConcurrentConnections": 5,
              "folderPath": "acme/business/customers/holidaySales"
          }
      },
      "connectionSpec": {
          "id": "b7bf2577-4520-42c9-bae9-cad01560f7bc",
          "version": "1.0"
      }
  }'
屬性 說明
auth.params.host SFTP伺服器的主機名稱。
auth.params.port SFTP伺服器的連線埠。 此整數值預設為22。
auth.params.username 與您的SFTP伺服器相關聯的使用者名稱。
auth.params.password 與您的SFTP伺服器關聯的密碼。
auth.params.maxConcurrentConnections 將Platform連線至SFTP時指定的同時連線數目上限。 啟用時，此值必須設定為至少1。
auth.params.folderPath 您要提供存取權的資料夾路徑。
connectionSpec.id SFTP伺服器連線規格ID： b7bf2577-4520-42c9-bae9-cad01560f7bc 
curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "SFTP connector with SSH authentication",
      "description": "SFTP connector with SSH authentication",
      "auth": {
          "specName": "SSH PublicKey Authentication for sftp",
          "params": {
              "host": "{HOST}",
              "port": 22,
              "userName": "{USERNAME}",
              "privateKeyContent": "{PRIVATE_KEY_CONTENT}",
              "passPhrase": "{PASSPHRASE}",
              "maxConcurrentConnections": 5,
              "folderPath": "acme/business/customers/holidaySales"
          }
      },
      "connectionSpec": {
          "id": "b7bf2577-4520-42c9-bae9-cad01560f7bc",
          "version": "1.0"
      }
  }'
屬性 說明
auth.params.host 的主機名稱 SFTP 伺服器。
auth.params.port SFTP伺服器的連線埠。 此整數值預設為22。
auth.params.username 與您的相關聯的使用者名稱 SFTP 伺服器。
auth.params.privateKeyContent Base64編碼的SSH私密金鑰內容。 OpenSSH金鑰型別必須分類為RSA或DSA。
auth.params.passPhrase 如果金鑰檔案或金鑰內容受到密語保護，則用來解密私密金鑰的密語或密碼。 如果PrivateKeyContent受密碼保護，則此引數必須搭配PrivateKeyContent的密碼短語作為值使用。
auth.params.maxConcurrentConnections 將Platform連線至SFTP時指定的同時連線數目上限。 啟用時，此值必須設定為至少1。
auth.params.folderPath 您要提供存取權的資料夾路徑。
connectionSpec.id 此 SFTP 伺服器連線規格ID： b7bf2577-4520-42c9-bae9-cad01560f7bc

回應

成功的回應會傳回唯一識別碼(id)。 在下一個教學課程中，探索您的SFTP伺服器時，需要此ID。

{
    "id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
    "etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}

後續步驟

依照本教學課程，您已建立 SFTP 使用下列專案的連線： Flow Service API中，且已取得連線的唯一ID值。 您可以使用此連線ID來 使用流量服務API探索雲端儲存空間.

本頁內容