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

最後更新： 2025年6月24日

主題：

建立對象：

開發人員

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

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

快速入門

本指南需要您深入了解下列 Adobe Experience Platform 元件：

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

重要

當擷取具有SFTP來源連線的JSON物件時，建議避免換行或歸位。若要解決此限制，請在每行使用單一JSON物件，並使用多行作為後續檔案。

下列章節提供您需瞭解的其他資訊，才能使用Flow Service API成功連線到SFTP伺服器。

收集必要的認證

請閱讀SFTP 驗證指南，以瞭解如何擷取驗證認證的詳細步驟。

使用Experience Platform API

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

建立基礎連線

秘訣

建立後，您無法變更SFTP基本連線的驗證型別。若要變更驗證型別，您必須建立新的基礎連線。

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

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

若要建立基底連線ID，請在提供您的SFTP驗證認證作為要求引數的一部分時，對/connections端點提出POST要求。

重要

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

API格式

POST /connections

基本驗證

要求

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",
              "disableChunking": "true"
          }
      },
      "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

將Experience Platform連線至SFTP時指定的同時連線數目上限。啟用時，此值必須設定為至少1。

auth.params.folderPath

您要提供存取權的資料夾路徑。

auth.params.disableChunking

布林值，用來判斷您的SFTP伺服器是否支援區塊。

connectionSpec.id

SFTP伺服器連線規格識別碼： b7bf2577-4520-42c9-bae9-cad01560f7bc

回應

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

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

SSH公開金鑰驗證

要求

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",
              "disableChunking": "true"
          }
      },
      "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金鑰型別為ed25519、RSA和DSA。

auth.params.passPhrase

如果金鑰檔案或金鑰內容受密語保護，則將私密金鑰解密的密語或密碼。如果PrivateKeyContent受密碼保護，此引數必須搭配PrivateKeyContent的密碼短語作為值使用。