使用Flow Service API建立SFTP來源連線

本教學課程使用Flow Service API來引導您完成將Experience Platform連接至SFTP(安全檔案傳輸協定)伺服器的步驟。

快速入門

本指南需要對Adobe Experience Platform的下列組成部分有切實的瞭解:

  • 來源:Experience Platform可讓您從各種來源擷取資料,同時讓您能夠使用平台服務來建構、標示並增強傳入資料。
  • 沙盒:Experience Platform提供虛擬沙盒,可將單一平台實例分割為獨立的虛擬環境,以協助開發和發展數位體驗應用程式。
重要

建議在使用SFTP來源連線來收錄JSON物件時,避免新行或回車。 若要解決限制,請每行使用單一JSON物件,並使用多行來建立後續檔案。

以下各節提供您需要知道的其他資訊,以便使用Flow Service API成功連線至SFTP伺服器。

收集必要的認證

要使Flow Service連接到SFTP,必須為以下連接屬性提供值:

憑證 說明
host 與您的SFTP伺服器相關聯的名稱或IP位址。
username 可存取您SFTP伺服器的使用者名稱。
password SFTP伺服器的密碼。
privateKeyContent Base64編碼的SSH私鑰內容。 OpenSSH密鑰的類型必須分類為RSA或DSA。
passPhrase 如果密鑰檔案或密鑰內容受密碼片語保護,則解密密鑰的密碼或密碼。 如果PrivateKeyContent受到密碼保護,則此參數必須與PrivateKeyContent的密碼短語一起使用,作為值。

讀取範例API呼叫

本教學課程提供範例API呼叫,以示範如何設定請求的格式。 這些包括路徑、必要標題和正確格式化的請求負載。 也提供API回應中傳回的範例JSON。 如需範例API呼叫檔案中所用慣例的詳細資訊,請參閱Experience Platform疑難排解指南中如何讀取範例API呼叫一節。

收集必要標題的值

若要呼叫平台API,您必須先完成驗證教學課程。 完成驗證教學課程後,將提供所有Experience PlatformAPI呼叫中每個必要標題的值,如下所示:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Experience Platform中的所有資源(包括屬於Flow Service的資源)都隔離到特定的虛擬沙盒。 對Platform API的所有請求都需要一個標題,該標題指定要在中執行操作的沙盒的名稱:

  • x-sandbox-name: {SANDBOX_NAME}

所有包含裝載(POST、PUT、PATCH)的請求都需要附加的媒體類型標題:

  • Content-Type: application/json

建立連線

連接指定源,並包含該源的憑據。 只需要一個連接,因為它可用於建立多個資料流以引入不同的資料。

使用基本驗證建立SFTP連線

若要使用基本驗證建立SFTP連線,請向Flow Service API提出POST要求,同時提供連線的hostuserNamepassword值。

API格式

POST /connections

請求

若要建立SFTP連線,其唯一連線規格ID必須作為POST要求的一部分提供。 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: {IMS_ORG}' \
    -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\""
}

使用SSH公鑰驗證建立SFTP連接

要使用SSH公鑰驗證建立SFTP連接,請向Flow Service API發出POST請求,同時為連接的hostuserNameprivateKeyContentpassPhrase提供值。

重要

SFTP連接器支援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: {IMS_ORG}' \
    -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)。 在下一個教學課程中,瀏覽您的SFTP伺服器時需要此ID。

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

後續步驟

在本教程中,您已使用Flow Service API建立SFTP連線,並取得連線的唯一ID值。 您可以使用此連線ID來探索使用Flow Service API](…/…/explore/cloud-storage.md)或使用Flow Service API來內嵌Parce資料的雲端儲存空間。[

本頁內容

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now