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) utilizando Flow Service API.
Esta guía requiere conocer los siguientes componentes de Adobe Experience Platform:
Se recomienda evitar nuevas líneas o retornos de carro al introducir objetos JSON con un SFTP conexión de origen. 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 SFTP servidor que utiliza la variable Flow Service API.
Para Flow Service para conectarse 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 SFTP servidor. |
port |
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 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 la variable privateKeyContent está protegido con 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 . |
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.
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 /connections
al proporcionar su SFTP credenciales de autenticación como parte de los parámetros de solicitud.
Para crear un SFTP conexión base usando autenticación básica, realice una solicitud de POST al Flow Service API mientras proporciona valores para la host
, userName
y password
.
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: {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}",
"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\""
}
Para crear un SFTP conexión base usando autenticación de clave pública SSH, realice una solicitud de POST al Flow Service API mientras proporciona valores para la host
, userName
, privateKeyContent
y passPhrase
.
La variable SFTP El conector admite una clave OpenSSH de tipo RSA o DSA. Asegúrese de que el contenido del archivo clave comience por "-----BEGIN [RSA/DSA] PRIVATE KEY-----"
y termina con "-----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: {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}",
"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 SFTP servidor. |
auth.params.username |
El nombre de usuario asociado con su SFTP servidor. |
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 |
La variable SFTP ID de especificación de conexión del servidor: 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 su SFTP en el siguiente tutorial.
{
"id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
"etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}
Al seguir este tutorial, ha creado un SFTP conexión mediante la función Flow Service y han 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.