Cree una conexión base SFTP con el Flow Service API
Last update: Tue Oct 31 2023 00:00:00 GMT+0000 (Coordinated Universal Time)
Una conexión base representa la conexión autenticada entre un origen y Adobe Experience Platform.
Este tutorial lo acompañará durante los pasos para crear una conexión base para SFTP (Protocolo seguro de transferencia de archivos) utilizando Flow Service API.
Introducción
Esta guía requiere una comprensión práctica de los siguientes componentes de Adobe Experience Platform:
- Fuentes: Experience Platform permite la ingesta de datos desde varias fuentes y, al mismo tiempo, le ofrece la capacidad de estructurar, etiquetar y mejorar los datos entrantes mediante los servicios de Platform.
- Zonas protegidas: El Experience Platform proporciona entornos limitados virtuales que dividen una sola instancia de Platform en entornos virtuales independientes para ayudar a desarrollar y evolucionar aplicaciones de experiencia digital.
Se recomienda evitar líneas nuevas o retornos de carro al ingerir objetos JSON con un SFTP conexión de origen. Para solucionar la limitación, utilice un solo objeto JSON por línea y utilice varias líneas para los archivos siguientes.
Las secciones siguientes proporcionan información adicional que deberá conocer para conectarse correctamente a un SFTP servidor que utiliza el Flow Service API.
Recopilar credenciales necesarias
Para que Flow Service para conectarse a SFTP, debe proporcionar valores para las siguientes propiedades de conexión:
host
El nombre o la dirección IP asociados con su SFTP servidor.
port
El puerto del servidor SFTP al que se está conectando. Si no se proporciona, el valor predeterminado es 22.
username
El nombre de usuario con acceso a su SFTP servidor.
password
La contraseña de su SFTP servidor.
privateKeyContent
El contenido de clave privada SSH codificado en Base64. El tipo de clave OpenSSH debe clasificarse como RSA o DSA.
passPhrase
La contraseña o frase de paso para descifrar la clave privada si el archivo de clave o el contenido de la clave están protegidos por una frase de paso. Si la variable privateKeyContent Si está protegido con contraseña, este parámetro debe utilizarse con la frase de contraseña del contenido de la clave privada como valor.
maxConcurrentConnections
Este parámetro le permite especificar un límite máximo para el número de conexiones simultáneas que Platform creará al conectarse al servidor SFTP. Debe configurar este valor para que sea inferior al límite establecido por SFTP. Nota: Cuando esta configuración está habilitada para una cuenta SFTP existente, solo afectará a flujos de datos futuros y no a flujos de datos existentes.
folderPath
La ruta a la carpeta a la que desea proporcionar acceso. SFTP origen, puede proporcionar la ruta de la carpeta para especificar el acceso del usuario a la subcarpeta que elija.
connectionSpec.id
La especificación de conexión devuelve las propiedades del conector de origen, incluidas las especificaciones de autenticación relacionadas con la creación de las conexiones base y origen. Identificador de especificación de conexión para SFTP es: b7bf2577-4520-42c9-bae9-cad01560f7bc.
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.
Cree una conexión base
Una vez creado, no se puede cambiar el tipo de autenticación de una SFTP conexión base. Para cambiar el tipo de autenticación, debe crear una nueva conexión base.
Una conexión base retiene información entre el origen y Platform, incluidas las credenciales de autenticación del origen, el estado actual de la conexión y el ID único de conexión base. El ID de conexión base le permite explorar y navegar por archivos desde el origen e identificar los elementos específicos que desea introducir, incluida la información sobre sus tipos de datos y formatos.
El SFTP source admite la autenticación básica y la autenticación mediante clave pública SSH. Durante este paso, también puede designar la ruta a la subcarpeta a la que desea proporcionar acceso.
Para crear un ID de conexión base, realice una solicitud de POST al /connections extremo al proporcionar su SFTP credenciales de autenticación como parte de los parámetros de solicitud.
El SFTP El conector admite una clave OpenSSH de tipo RSA o DSA. Asegúrese de que el contenido del archivo de claves comience 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 de formato PPK a formato OpenSSH.
Formato de API
Autenticación básica
| accordion |
| Solicitud |
| code language-shell |
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}",
"port": 22,
"userName": "{USERNAME}",
"password": "{PASSWORD}",
"maxConcurrentConnections": 5,
"folderPath": "acme/business/customers/holidaySales"
}
},
"connectionSpec": {
"id": "b7bf2577-4520-42c9-bae9-cad01560f7bc",
"version": "1.0"
}
}'
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 |
|
| Propiedad |
Descripción |
auth.params.host |
El nombre de host del servidor SFTP. |
auth.params.port |
El puerto del servidor SFTP. El valor predeterminado de este entero es 22. |
auth.params.username |
El nombre de usuario asociado con el servidor SFTP. |
auth.params.password |
La contraseña asociada a su servidor SFTP. |
auth.params.maxConcurrentConnections |
Número máximo de conexiones simultáneas especificadas al conectar Platform a SFTP. Cuando está habilitado, este valor debe establecerse en al menos 1. |
auth.params.folderPath |
La ruta a la carpeta a la que desea proporcionar acceso. |
connectionSpec.id |
ID de especificación de conexión del servidor SFTP: b7bf2577-4520-42c9-bae9-cad01560f7bc |
|
| accordion |
| 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.
| code language-json |
{
"id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
"etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}
|
|
Autenticación de clave pública SSH
| accordion |
| Solicitud |
| code language-shell |
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}",
"port": 22,
"userName": "{USERNAME}",
"privateKeyContent": "{PRIVATE_KEY_CONTENT}",
"passPhrase": "{PASSPHRASE}",
"maxConcurrentConnections": 5,
"folderPath": "acme/business/customers/holidaySales"
}
},
"connectionSpec": {
"id": "b7bf2577-4520-42c9-bae9-cad01560f7bc",
"version": "1.0"
}
}'
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 |
|
| Propiedad |
Descripción |
auth.params.host |
El nombre de host de su SFTP servidor. |
auth.params.port |
El puerto del servidor SFTP. El valor predeterminado de este entero es 22. |
auth.params.username |
El nombre de usuario asociado con su SFTP servidor. |
auth.params.privateKeyContent |
El contenido de clave privada SSH codificado en Base64. El tipo de clave OpenSSH debe clasificarse como RSA o DSA. |
auth.params.passPhrase |
La contraseña o frase de paso para descifrar la clave privada si el archivo de clave o el contenido de la clave están protegidos por una frase de paso. Si PrivateKeyContent está protegido con contraseña, este parámetro debe utilizarse con la frase de contraseña de PrivateKeyContent como valor. |
auth.params.maxConcurrentConnections |
Número máximo de conexiones simultáneas especificadas al conectar Platform a SFTP. Cuando está habilitado, este valor debe establecerse en al menos 1. |
auth.params.folderPath |
La ruta a la carpeta a la que desea proporcionar acceso. |
connectionSpec.id |
El SFTP Id. de especificación de conexión de servidor: b7bf2577-4520-42c9-bae9-cad01560f7bc |
|
| accordion |
| 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.
| code language-json |
{
"id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
"etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}
|
|
Pasos siguientes
Al seguir este tutorial, ha creado un SFTP conexión mediante el Flow Service API y han obtenido el valor de ID único de la conexión. Puede usar este ID de conexión para lo siguiente explore los almacenes en la nube mediante la API de Flow Service.