使用 Flow Service API

基連接表示源和Adobe Experience Platform之間經過驗證的連接。

本教程將指導您完成建立基本連接的步驟 SFTP （安全檔案傳輸協定） Flow Service API。

快速入門

本指南要求對Adobe Experience Platform的下列組成部分有工作上的理解：

  • 源:Experience Platform允許從各種源接收資料，同時讓您能夠使用平台服務構建、標籤和增強傳入資料。
  • 沙箱:Experience Platform提供虛擬沙箱，將單個平台實例分區為獨立的虛擬環境，以幫助開發和發展數字型驗應用程式。
重要

建議在使用JSON對象插入時避免新行或回車 SFTP 源連接。 要繞過限制，請每行使用一個JSON對象，並使用多行來獲取後續檔案。

以下各節提供了成功連接到 SFTP 使用 Flow Service API。

收集所需憑據

為了 Flow Service 連接到 SFTP，必須為以下連接屬性提供值：

憑據 說明
host 與您的 SFTP 伺服器。
port 您要連接的SFTP伺服器埠。 如果未提供，則值預設為 22。
username 有權訪問您的 SFTP 伺服器。
password 您的密碼 SFTP 伺服器。
privateKeyContent Base64編碼的SSH私鑰內容。 OpenSSH密鑰的類型必須分為RSA或DSA。
passPhrase 如果密鑰檔案或密鑰內容受密碼片語保護，則解密私鑰的密碼或密碼。 如果 privateKeyContent 受密碼保護，此參數需要與私鑰內容的密碼短語一起使用作值。
connectionSpec.id 連接規範返回源的連接器屬性，包括與建立基連接和源連接相關的驗證規範。 連接規範ID SFTP 為： b7bf2577-4520-42c9-bae9-cad01560f7bc。

使用平台API

有關如何成功調用平台API的資訊，請參見上的指南 平台API入門。

建立基本連接

基本連接將保留源和平台之間的資訊，包括源的驗證憑據、連接的當前狀態和唯一的基本連接ID。 基本連接ID允許您從源中瀏覽和導航檔案，並標識要攝取的特定項目，包括有關其資料類型和格式的資訊。

要建立基本連接ID，請向 /connections 提供端點 SFTP 身份驗證憑據作為請求參數的一部分。

建立 SFTP 基本連接使用基本認證

建立 SFTP 基本連接使用基本身份驗證，向POST請求 Flow Service API，同時為連接提供值 host。 userName, password。

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}",
                "userName": "{USERNAME}",
                "password": "{PASSWORD}"
            }
        },
        "connectionSpec": {
            "id": "b7bf2577-4520-42c9-bae9-cad01560f7bc",
            "version": "1.0"
        }
    }'
屬性 說明
auth.params.host SFTP伺服器的主機名。
auth.params.username 與SFTP伺服器關聯的用戶名。
auth.params.password 與SFTP伺服器關聯的密碼。
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 使用SSH公鑰身份驗證的基本連接

建立 SFTP 基本連接使用SSH公鑰身份驗證，向POST請求 Flow Service API，同時為連接提供值 host。 userName。 privateKeyContent, passPhrase。

重要

的 SFTP 連接器支援RSA或DSA類型OpenSSH密鑰。 確保密鑰檔案內容以 "-----BEGIN [RSA/DSA] PRIVATE KEY-----" 結尾 "-----END [RSA/DSA] PRIVATE KEY-----"。 如果私鑰檔案是PPK格式檔案，請使用PuTTY工具將PPK格式轉換為OpenSSH格式。

API格式

POST /connections

要求

以下請求為 SFTP 使用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}",
                "userName": "{USERNAME}",
                "privateKeyContent": "{PRIVATE_KEY_CONTENT}",
                "passPhrase": "{PASSPHRASE}"
            }
        },
        "connectionSpec": {
            "id": "b7bf2577-4520-42c9-bae9-cad01560f7bc",
            "version": "1.0"
        }
    }'
屬性 說明
auth.params.host 您的主機名 SFTP 伺服器。
auth.params.username 與您的 SFTP 伺服器。
auth.params.privateKeyContent Base64編碼的SSH私鑰內容。 OpenSSH密鑰的類型必須分為RSA或DSA。
auth.params.passPhrase 如果密鑰檔案或密鑰內容受密碼片語保護，則解密私鑰的密碼或密碼。 如果PrivateKeyContent受密碼保護，則此參數需要與PrivateKeyContent的密碼短語一起作為值使用。
connectionSpec.id 的 SFTP 伺服器連接規範ID: b7bf2577-4520-42c9-bae9-cad01560f7bc

回應

成功的響應返回唯一標識符(id)。 需要此ID來瀏覽 SFTP 伺服器。

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

後續步驟

按照本教程，您建立了 SFTP 使用 Flow Service API，並已獲取連接的唯一ID值。 您可以使用此連接ID 使用流服務API瀏覽雲儲存。

本頁內容