Créer une connexion de base SFTP à l’aide de l’API Flow Service
Last update: Tue Sep 24 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
Une connexion de base représente la connexion authentifiée entre une source et Adobe Experience Platform.
Ce tutoriel vous guide tout au long des étapes pour créer une connexion de base pour SFTP (protocole de transfert de fichiers sécurisé) à l’aide de l’ Flow Service API.
Prise en main
Ce guide nécessite une compréhension professionnelle des composants suivants d’Adobe Experience Platform :
- Sources : Experience Platform permet d’ingérer des données provenant de diverses sources tout en vous offrant la possibilité de structurer, d’étiqueter et d’améliorer les données entrantes à l’aide des services de Platform.
- Sandbox : Experience Platform fournit des sandbox virtuels qui divisent une instance de plateforme unique en environnements virtuels distincts pour favoriser le développement et l’évolution d’applications d’expérience digitale.
Il est recommandé d’éviter les nouvelles lignes ou les retours chariot lors de l’ingestion d’objets JSON avec une connexion source SFTP. Pour contourner cette limitation, utilisez un seul objet JSON par ligne et plusieurs lignes pour les fichiers qui s’ensuivent.
Les sections suivantes apportent des informations supplémentaires dont vous aurez besoin pour vous connecter avec succès à un serveur SFTP à l’aide de l’API Flow Service.
Lisez le SFTP guide d'authentification pour obtenir des instructions détaillées sur la manière de récupérer vos informations d'authentification.
Pour plus d’informations sur la manière d’effectuer avec succès des appels vers les API Platform, consultez le guide sur la Prise en main des API Platform.
Créer une connexion de base
Une fois créé, vous ne pouvez pas modifier le type d'authentification d'une connexion de base SFTP. Pour modifier le type d'authentification, vous devez créer une nouvelle connexion de base.
Une connexion de base conserve les informations échangées entre votre source et Platform, y compris les informations d’authentification de votre source, l’état actuel de la connexion et votre identifiant de connexion de base unique. L’identifiant de connexion de base vous permet d’explorer et de parcourir des fichiers à partir de votre source et d’identifier les éléments spécifiques que vous souhaitez ingérer, y compris des informations concernant leurs types et formats de données.
La source SFTP prend en charge l’authentification et l’authentification de base via la clé publique SSH. Au cours de cette étape, vous pouvez également désigner le chemin d’accès au sous-dossier auquel vous souhaitez accorder l’accès.
Pour créer un identifiant de connexion de base, envoyez une requête POST au point d’entrée /connections lors de la fourniture des informations d’identification d’authentification SFTP dans le cadre des paramètres de requête.
Le connecteur SFTP prend en charge une clé OpenSSH de type RSA ou DSA. Assurez-vous que le contenu de votre fichier clé commence par "-----BEGIN [RSA/DSA] PRIVATE KEY-----" et se termine par "-----END [RSA/DSA] PRIVATE KEY-----". Si le fichier de clé privée est un fichier au format PPK, utilisez l’outil PuTTY pour effectuer une conversion de PPK au format OpenSSH.
Format d’API
Authentification de base
| accordion |
| Requête |
| 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",
"disableChunking": "true"
}
},
"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 |
|
| Propriété |
Description |
auth.params.host |
Nom d’hôte de votre serveur SFTP. |
auth.params.port |
Port du serveur SFTP. Cette valeur entière est définie par défaut sur 22. |
auth.params.username |
Nom d’utilisateur associé à votre serveur SFTP. |
auth.params.password |
mot de passe associé à votre serveur SFTP. |
auth.params.maxConcurrentConnections |
Nombre maximal de connexions simultanées spécifiées lors de la connexion de Platform à SFTP. Lorsqu’elle est activée, cette valeur doit être définie sur au moins 1. |
auth.params.folderPath |
Chemin d’accès au dossier auquel vous souhaitez accorder l’accès. |
auth.params.disableChunking |
Valeur boolean utilisée pour déterminer si votre serveur SFTP prend ou non en charge le découpage. |
connectionSpec.id |
ID de spécification de connexion au serveur SFTP : b7bf2577-4520-42c9-bae9-cad01560f7bc |
|
| accordion |
| Réponse |
|
Une réponse réussie renvoie l’identifiant unique (id) de la nouvelle connexion. Cet identifiant est nécessaire pour explorer votre serveur SFTP dans le tutoriel suivant.
| code language-json |
{
"id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
"etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}
|
|
Authentification de clé publique SSH
| accordion |
| Requête |
| 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",
"disableChunking": "true"
}
},
"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 9-row-2 |
|
| Propriété |
Description |
auth.params.host |
Nom d’hôte de votre serveur SFTP. |
auth.params.port |
Port du serveur SFTP. Cette valeur entière est définie par défaut sur 22. |
auth.params.username |
Nom d’utilisateur associé à votre serveur SFTP. |
auth.params.privateKeyContent |
Contenu de clé privée SSH codée en Base64. Le type de clé OpenSSH doit être classé en tant que RSA ou DSA. |
auth.params.passPhrase |
L’expression de passe ou le mot de passe pour déchiffrer la clé privée si le fichier de clé ou le contenu de la clé est protégé par une expression de passe. Si PrivateKeyContent est protégé par mot de passe, ce paramètre doit être utilisé avec comme valeur le mot de passe de PrivateKeyContent. |
auth.params.maxConcurrentConnections |
Nombre maximal de connexions simultanées spécifiées lors de la connexion de Platform à SFTP. Lorsqu’elle est activée, cette valeur doit être définie sur au moins 1. |
auth.params.folderPath |
Chemin d’accès au dossier auquel vous souhaitez accorder l’accès. |
auth.params.disableChunking |
Valeur boolean utilisée pour déterminer si votre serveur SFTP prend ou non en charge le découpage. |
connectionSpec.id |
ID de spécification de connexion au serveur SFTP : b7bf2577-4520-42c9-bae9-cad01560f7bc |
|
| accordion |
| Réponse |
|
Une réponse réussie renvoie l’identifiant unique (id) de la nouvelle connexion. Cet identifiant est nécessaire pour explorer votre serveur SFTP dans le tutoriel suivant.
| code language-json |
{
"id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
"etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}
|
|