Créez une connexion de base SFTP à l’aide de la Flow Service API

Une connexion de base représente la connexion authentifiée entre une source et Adobe Experience Platform.

Ce tutoriel vous explique les étapes à suivre pour créer une connexion de base pour SFTP (Secure File Transfer Protocol) à l’aide de la 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 l’assimilation de données à partir de diverses sources tout en vous permettant de structurer, étiqueter et améliorer les données entrantes à l’aide des services de la plate-forme.
• Environnements de test : Experience Platform fournit des environnements de test 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 numérique.

Les sections suivantes fournissent des informations supplémentaires que vous devez connaître pour vous connecter à un SFTP à l’aide de la Flow Service API.

Collecte des informations d’identification requises

Pour Flow Service pour se connecter à SFTP, vous devez fournir des valeurs pour les propriétés de connexion suivantes :

Utilisation des API de plate-forme

Pour plus d’informations sur la manière d’effectuer des appels vers les API de plate-forme, consultez le guide sur prise en main des API de plate-forme.

Création d’une connexion de base

Une connexion de base conserve les informations entre votre source et la plate-forme, y compris les informations d'identification de votre source, l'état actuel de la connexion et votre ID de connexion de base unique. L’ID de connexion de base vous permet d’explorer et de parcourir les fichiers à partir de votre source et d’identifier les éléments spécifiques que vous souhaitez assimiler, y compris des informations concernant leurs types et formats de données.

Pour créer un ID de connexion de base, effectuez une demande de POST à l’adresse /connections point de terminaison lors de la fourniture de votre SFTP les informations d'identification d'authentification dans le cadre des paramètres de demande.

Créer un SFTP connexion de base à l'aide de l'authentification de base

Pour créer un SFTP connexion de base à l’aide de l’authentification de base, effectuez une demande de POST à l’adresse suivante : Flow Service API tout en fournissant des valeurs pour votre connexion host, userNameet password.

Format d’API

POST /connections

Requête

La demande suivante crée une connexion de base pour SFTP à l'aide de l'authentification de base :

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"
        }
    }'

Réponse

Une réponse réussie renvoie l'identifiant unique (id) de la connexion nouvellement créée. Cet ID est nécessaire pour explorer votre serveur SFTP dans le tutoriel suivant.

{
    "id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
    "etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}

Créer un SFTP connexion de base à l'aide de l'authentification à clé publique SSH

Pour créer un SFTP connexion de base à l’aide de l’authentification de clé publique SSH, effectuez une demande de POST à l’adresse suivante : Flow Service API tout en fournissant des valeurs pour votre connexion host, userName, privateKeyContentet passPhrase.

Format d’API

POST /connections

Requête

La demande suivante crée une connexion de base pour SFTP à l'aide de l'authentification à clé publique 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: {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"
        }
    }'

Réponse

Une réponse réussie renvoie l'identifiant unique (id) de la connexion nouvellement créée. Cet ID est nécessaire pour explorer votre SFTP dans le tutoriel suivant.

{
    "id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
    "etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}

Étapes suivantes

En suivant ce tutoriel, vous avez créé un fichier SFTP connexion à l’aide de la Flow Service et ont obtenu la valeur d’ID unique de la connexion. Vous pouvez utiliser cet ID de connexion pour exploration des sites de stockage dans le cloud à l’aide de l’API Flow Service.