Show Menu
SUJETS×

Création d’un connecteur SFTP à l’aide de l’ Flow Service API

Le connecteur SFTP est en version bêta. Les fonctionnalités et la documentation peuvent faire l’objet de changements. Pour plus d’informations sur l’utilisation de connecteurs bêta, consultez l’aperçu des sources.
Flow Service est utilisée pour collecter et centraliser les données client provenant de diverses sources disparates à Adobe Experience Platform. Le service fournit une interface utilisateur et une API RESTful à partir de laquelle toutes les sources prises en charge sont connectables.
Ce didacticiel utilise l’ Flow Service API pour vous guider à travers les étapes de la connexion Experience Platform à un serveur SFTP (Secure File Transfer Protocol).
Si vous préférez utiliser l’interface utilisateur dans Experience Platform, le didacticiel Création d’un connecteur source FTP ou SFTP dans l’interface utilisateur IU fournit des instructions détaillées pour exécuter des actions similaires.

Prise en main

Ce guide nécessite une compréhension professionnelle des composants suivants d’Adobe Experience Platform :
  • Sources : Experience Platform permet l’assimilation de données à partir de diverses sources tout en vous permettant de structurer, d’étiqueter et d’améliorer les données entrantes à l’aide de Platform services.
  • Sandbox : Experience Platform fournit des sandbox virtuels qui partitionnent une Platform instance unique en environnements virtuels distincts pour aider à développer et développer des applications d'expérience numérique.
The following sections provide additional information that you will need to know in order to successfully connect to an SFTP server using the Flow Service API.

Collecte des informations d’identification requises

Pour vous connecter Flow Service au protocole SFTP, vous devez fournir des valeurs pour les propriétés de connexion suivantes :
Informations d’identification
Description
host
Nom ou adresse IP associé à votre serveur SFTP.
username
Nom d’utilisateur ayant accès à votre serveur SFTP.
password
Mot de passe de votre serveur SFTP.
privateKeyContent
Le contenu de la clé privée SSH codée en Base64. Le format de la clé privée SSH OpenSSH (RSA/DSA).
passPhrase
Expression de passe ou 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 un mot de passe, ce paramètre doit être utilisé avec la phrase secrète de PrivateKeyContent comme valeur.

Lecture d’exemples d’appels API

Ce tutoriel fournit des exemples d’appels API pour démontrer comment formater vos requêtes. Il s’agit notamment de chemins d’accès, d’en-têtes requis et de payloads de requêtes correctement formatés. L’exemple JSON renvoyé dans les réponses de l’API est également fourni. For information on the conventions used in documentation for sample API calls, see the section on how to read example API calls in the Experience Platform troubleshooting guide.

Collecte des valeurs des en-têtes requis

In order to make calls to Platform APIs, you must first complete the authentication tutorial . Completing the authentication tutorial provides the values for each of the required headers in all Experience Platform API calls, as shown below:
  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
All resources in Experience Platform, including those belonging to the Flow Service, are isolated to specific virtual sandboxes. All requests to Platform APIs require a header that specifies the name of the sandbox the operation will take place in:
  • x-sandbox-name: {SANDBOX_NAME}
Toutes les requêtes qui contiennent un payload (POST, PUT, PATCH) nécessitent un en-tête de type de média supplémentaire :
  • Content-Type: application/json

Création d’une connexion

Une connexion spécifie une source et contient vos informations d’identification pour cette source. Une seule connexion est requise par compte SFTP, car elle peut être utilisée pour créer plusieurs connecteurs source pour importer des données différentes.

Création d’une connexion SFTP à l’aide d’une authentification de base

Pour créer une connexion SFTP à l’aide de l’authentification de base, faites une demande de POST à l’ Flow Service API tout en fournissant des valeurs pour les host , userName et password la connexion.
Format d’API
POST /connections

Requête
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"
        }
    }'

Propriété
Description
auth.params.host
Nom d’hôte de votre serveur SFTP.
auth.params.username
Nom d’utilisateur associé à votre serveur SFTP.
auth.params.password
Mot de passe associé à votre serveur SFTP.
connectionSpec.id
ID de spécification de connexion au serveur SFTP : b7bf2577-4520-42c9-bae9-cad01560f7bc
Réponse
Une réponse réussie renvoie l'identifiant unique ( id ) de la connexion nouvellement créée. Cet identifiant est nécessaire pour explorer votre serveur SFTP dans le didacticiel suivant.
{
    "id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
    "etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}

Création d’une connexion SFTP à l’aide de l’authentification de clé publique SSH

Pour créer une connexion SFTP à l’aide de l’authentification de clé publique SSH, faites une demande de POST à l’ Flow Service API tout en fournissant des valeurs pour les host userName , privateKeyContent et passPhrase lesconnexions.
Format d’API
POST /connections

Requête
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"
        }
    }'

Propriété
Description
auth.params.host
Nom d’hôte de votre serveur SFTP.
auth.params.username
Nom d’utilisateur associé à votre serveur SFTP.
auth.params.privateKeyContent
Contenu de clé privée SSH codée en base 64. Le format de la clé privée SSH OpenSSH (RSA/DSA).
auth.params.passPhrase
Expression de passe ou 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 un mot de passe, ce paramètre doit être utilisé avec la phrase secrète de PrivateKeyContent comme valeur.
connectionSpec.id
ID de spécification de connexion au serveur SFTP : b7bf2577-4520-42c9-bae9-cad01560f7bc
Réponse
Une réponse réussie renvoie l'identifiant unique ( id ) de la connexion nouvellement créée. Cet identifiant est nécessaire pour explorer votre serveur SFTP dans le didacticiel suivant.
{
    "id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
    "etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}

Étapes suivantes

En suivant ce didacticiel, vous avez créé une connexion SFTP à l’aide de l’ Flow Service API et obtenu la valeur d’ID unique de la connexion. Vous pouvez utiliser cet ID de connexion pour explorer les enregistrements de cloud à l’aide de l’API Flow Service ou assimiler des données de parquet à l’aide de l’API Flow Service.