使用Flow Service API创建SFTP基本连接

基本连接表示源与Adobe Experience Platform之间经过验证的连接。

本教程将指导您完成使用Flow Service API为SFTP（安全文件传输协议）创建基本连接的步骤。

快速入门

本指南要求您对Adobe Experience Platform的以下组件有一定的了解：

• 来源:Experience Platform允许从各种源摄取数据，同时让您能够使用Platform服务来构建、标记和增强传入数据。
• 沙盒:Experience Platform提供将单个Platform实例分区为单独虚拟环境的虚拟沙盒，以帮助开发和改进数字体验应用程序。

以下各节提供了您需要了解的其他信息，以便您能够使用Flow Service API成功连接到SFTP服务器。

收集所需的凭据

要使Flow Service连接到SFTP，必须为以下连接属性提供值：

使用Platform API

有关如何成功调用Platform API的信息，请参阅Platform API入门指南。

创建基本连接

基本连接保留了源和平台之间的信息，包括源的身份验证凭据、连接的当前状态和唯一基本连接ID。 基本连接ID允许您从源中浏览和导航文件，并标识要摄取的特定项目，包括有关其数据类型和格式的信息。

要创建基本连接ID，请在请求参数中提供SFTP身份验证凭据时，向/connections端点发出POST请求。

使用基本身份验证创建SFTP连接

要使用基本身份验证创建SFTP基本连接，请向Flow Service API发出POST请求，同时为连接的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: {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"
        }
    }'

响应

成功的响应会返回新创建连接的唯一标识符(id)。 在下一个教程中，浏览SFTP服务器时需要此ID。

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

使用SSH公钥身份验证创建SFTP连接

要使用SSH公钥身份验证创建SFTP基本连接，请向Flow Service API发出POST请求，同时为连接的host、userName、privateKeyContent和passPhrase提供值。

API格式

POST /connections

请求

以下请求使用SSH公钥身份验证为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: {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"
        }
    }'

响应

成功的响应会返回新创建连接的唯一标识符(id)。 在下一个教程中浏览SFTP服务器时需要此ID。

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

后续步骤

在本教程中，您已使用Flow Service API创建了SFTP连接，并获取了该连接的唯一ID值。 您可以使用此连接ID来使用流量服务API或使用流量服务API摄取Parquet数据来浏览云存储。