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

Este tutorial utiliza la API Flow Service para guiarle por los pasos para conectar el Experience Platform a un servidor SFTP (Protocolo seguro de transferencia de archivos).

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 deberá 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 del 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 PrivateKeyContent está protegido por contraseña, este parámetro debe utilizarse con la frase de contraseña de PrivateKeyContent como valor.

Leer llamadas de API de ejemplo

Este tutorial proporciona llamadas de API de ejemplo para demostrar cómo dar formato a las solicitudes. Estas incluyen rutas de acceso, encabezados necesarios y cargas de solicitud con el formato correcto. También se proporciona el JSON de muestra devuelto en las respuestas de API. Para obtener información sobre las convenciones utilizadas en la documentación para las llamadas de API de ejemplo, consulte la sección sobre cómo leer llamadas de API de ejemplo en la guía de solución de problemas del Experience Platform.

Recopilar valores para encabezados necesarios

Para realizar llamadas a las API de Platform, primero debe completar el tutorial de autenticación. Al completar el tutorial de autenticación, se proporcionan los valores para cada uno de los encabezados necesarios en todas las llamadas a la API de Experience Platform, como se muestra a continuación:

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

Todos los recursos de Experience Platform, incluidos los que pertenecen a Flow Service, están aislados en entornos limitados virtuales específicos. Todas las solicitudes a las API Platform requieren un encabezado que especifique el nombre del simulador para pruebas en el que se realizará la operación:

  • x-sandbox-name: {SANDBOX_NAME}

Todas las solicitudes que contienen una carga útil (POST, PUT, PATCH) requieren un encabezado de tipo de medio adicional:

  • Content-Type: application/json

Crear una conexión

Una conexión especifica un origen y contiene sus credenciales para ese origen. Solo se requiere una conexión, ya que se puede utilizar para crear varios flujos de datos que aporten datos diferentes.

Creación de una conexión SFTP mediante autenticación básica

Para crear una conexión SFTP usando autenticación básica, realice una solicitud de POST a la API Flow Service y proporcione los valores host, userName y password de la conexión.

Formato de API

POST /connections

Solicitud

Para crear una conexión SFTP, su ID de especificación de conexión única debe proporcionarse como parte de la solicitud del POST. El ID de especificación de conexión para SFTP es 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"
        }
    }'
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\""
}

Creación de una conexión SFTP mediante autenticación de clave pública SSH

Para crear una conexión SFTP usando la autenticación de clave pública SSH, realice una solicitud de POST a la API Flow Service y proporcione los valores 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

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 del servidor SFTP.
auth.params.username El nombre de usuario asociado al 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 con la API Flow Service y ha obtenido el valor de ID único 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

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