Creación de una conexión base SFTP mediante la API Flow Service

Una conexión base representa la conexión autenticada entre un origen y Adobe Experience Platform.

Este tutorial le guía por los pasos para crear una conexión base para SFTP (Protocolo seguro de transferencia de archivos) mediante la Flow Service API.

Primeros pasos

Esta guía requiere conocer los siguientes componentes de Adobe Experience Platform:

  • Fuentes: Experience Platform permite la ingesta de datos de varias fuentes, al mismo tiempo que le ofrece la capacidad de estructurar, etiquetar y mejorar los datos entrantes mediante los servicios de Platform.
  • Simuladores para pruebas: Experience Platform proporciona entornos limitados virtuales que dividen una sola instancia de Platform en entornos virtuales independientes para ayudar a desarrollar y desarrollar aplicaciones de experiencia digital.
IMPORTANTE

Se recomienda evitar nuevas líneas o retornos de carro al introducir objetos JSON con una conexión de origen SFTP. Para solucionar la limitación, utilice un único objeto JSON por línea y utilice líneas múltiples para los archivos posteriores.

Las secciones siguientes proporcionan información adicional que debe conocer para conectarse correctamente a un servidor SFTP mediante la API Flow Service.

Recopilar las credenciales necesarias

Para que Flow Service se conecte a SFTP, debe proporcionar valores para las siguientes propiedades de conexión:

Credencial Descripción
host El nombre o la dirección IP asociados con su servidor SFTP.
username El nombre de usuario con acceso a su servidor SFTP.
password La contraseña de su servidor SFTP.
privateKeyContent El contenido de clave privada SSH codificada Base64. El tipo de clave OpenSSH debe clasificarse como RSA o DSA.
passPhrase La frase de contraseña o contraseña para descifrar la clave privada si el archivo de clave o el contenido de la clave están protegidos por una frase de contraseña. Si el privateKeyContent está protegido mediante contraseña, este parámetro debe utilizarse con la frase de contraseña del contenido de clave privada como valor.
connectionSpec.id La especificación de conexión devuelve las propiedades del conector de un origen, incluidas las especificaciones de autenticación relacionadas con la creación de las conexiones base y de origen. El ID de especificación de conexión para SFTP es: b7bf2577-4520-42c9-bae9-cad01560f7bc.

Uso de las API de plataforma

Para obtener información sobre cómo realizar llamadas correctamente a las API de Platform, consulte la guía de introducción a las API de Platform.

Creación de una conexión base

Una conexión base retiene información entre la fuente y la plataforma, incluidas las credenciales de autenticación de la fuente, el estado actual de la conexión y el ID de conexión base único. El ID de conexión base le permite explorar y navegar archivos desde el origen e identificar los elementos específicos que desea introducir, incluida la información sobre sus tipos de datos y formatos.

Para crear un ID de conexión base, realice una solicitud de POST al extremo /connections y proporcione las credenciales de autenticación SFTP como parte de los parámetros de solicitud.

Crear una conexión SFTP utilizando la autenticación básica

Para crear una conexión base SFTP utilizando autenticación básica, realice una solicitud de POST a la API Flow Service mientras proporciona valores para las host, userName y password de la conexión.

Formato de API

POST /connections

Solicitud

La siguiente solicitud crea una conexión base para SFTP mediante autenticación básica:

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"
        }
    }'
Propiedad Descripción
auth.params.host El nombre de host del servidor SFTP.
auth.params.username El nombre de usuario asociado al servidor SFTP.
auth.params.password La contraseña asociada al servidor SFTP.
connectionSpec.id El ID de especificación de conexión del servidor SFTP: b7bf2577-4520-42c9-bae9-cad01560f7bc

Respuesta

Una respuesta correcta devuelve el identificador único (id) de la conexión recién creada. Este ID es necesario para explorar el servidor SFTP en el siguiente tutorial.

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

Crear una conexión SFTP utilizando la autenticación de clave pública SSH

Para crear una conexión base SFTP utilizando la autenticación de clave pública SSH, realice una solicitud de POST a la API Flow Service mientras proporciona valores para las API host, userName, privateKeyContent y passPhrase de la conexión.

IMPORTANTE

El conector SFTP admite una clave OpenSSH de tipo RSA o DSA. Asegúrese de que el contenido del archivo clave comienza por "-----BEGIN [RSA/DSA] PRIVATE KEY-----" y termina por "-----END [RSA/DSA] PRIVATE KEY-----". Si el archivo de clave privada es un archivo en formato PPK, utilice la herramienta PuTTY para convertir del formato PPK al formato OpenSSH.

Formato de API

POST /connections

Solicitud

La siguiente solicitud crea una conexión base para SFTP mediante autenticación de clave pública 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: {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"
        }
    }'
Propiedad Descripción
auth.params.host El nombre de host de su servidor SFTP.
auth.params.username El nombre de usuario asociado con su servidor SFTP.
auth.params.privateKeyContent El contenido de clave privada SSH codificada Base64. El tipo de clave OpenSSH debe clasificarse como RSA o DSA.
auth.params.passPhrase La frase de contraseña o contraseña para descifrar la clave privada si el archivo de clave o el contenido de la clave están protegidos por una frase de contraseña. Si PrivateKeyContent está protegido por contraseña, este parámetro debe utilizarse con la frase de contraseña de PrivateKeyContent como valor.
connectionSpec.id El ID de especificación de conexión del servidor SFTP: b7bf2577-4520-42c9-bae9-cad01560f7bc

Respuesta

Una respuesta correcta devuelve el identificador único (id) de la conexión recién creada. Este ID es necesario para explorar el servidor SFTP en el siguiente tutorial.

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

Pasos siguientes

Siguiendo este tutorial, ha creado una conexión SFTP utilizando la API Flow Service y ha obtenido el valor de ID exclusivo de la conexión. Puede utilizar este ID de conexión para explorar las tiendas en la nube mediante la API de servicio de flujo o incorporar datos de parqué mediante la API de servicio de flujo.

En esta página