Créer une connexion de base FTP à l’aide de l’API Flow Service

REMARQUE

Le connecteur FTP 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 la Présentation des sources .

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 FTP (protocole de transfert de fichiers) à 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 permettant de structurer, d’étiqueter et d’améliorer les données entrantes à l’aide de Platform services.
  • Environnements de test : Experience Platform fournit des environnements de test virtuels qui divisent une instance Platform unique en environnements virtuels distincts pour favoriser le développement et l’évolution d’applications d’expérience numérique.

Les sections suivantes apportent des informations supplémentaires dont vous aurez besoin pour vous connecter à un serveur FTP à l’aide de l’API Flow Service.

Collecte des informations d’identification requises

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

Credential Description
host Nom ou adresse IP associé à votre serveur FTP.
username Nom d’utilisateur ayant accès à votre serveur FTP.
password Mot de passe de votre serveur FTP.
connectionSpec.id La spécification de connexion renvoie les propriétés du connecteur d’une source, y compris les spécifications d’authentification liées à la création des connexions base et source. L’identifiant de spécification de connexion pour FTP est : fb2e94c9-c031-467d-8103-6bd6e0a432f2.

Utilisation des API Platform

Pour plus d’informations sur la manière d’effectuer des appels avec succès vers les API Platform, consultez le guide de prise en main des API Platform.

Création d’une connexion de base

Une connexion de base conserve les informations 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.

Pour créer un identifiant de connexion de base, envoyez une requête de POST au point de terminaison /connections tout en fournissant vos informations d’authentification FTP dans le cadre des paramètres de requête.

Format d’API

POST /connections

Requête

La requête suivante crée une connexion de base pour FTP :

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": "FTP connector with password",
        "description": "FTP connector password",
        "auth": {
            "specName": "Basic Authentication for FTP",
            "params": {
                "host": "{HOST}",
                "userName": "{USERNAME}",
                "password": "{PASSWORD}"
            }
        },
        "connectionSpec": {
            "id": "fb2e94c9-c031-467d-8103-6bd6e0a432f2",
            "version": "1.0"
        }
    }'
Propriété Description
auth.params.host Nom d’hôte de votre serveur FTP.
auth.params.username Nom d’utilisateur associé à votre serveur FTP.
auth.params.password mot de passe associé à votre serveur FTP.
connectionSpec.id L’identifiant de spécification de connexion au serveur FTP : fb2e94c9-c031-467d-8103-6bd6e0a432f2

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 FTP 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éé une connexion FTP à l’aide de l’API Flow Service et obtenu la valeur d’identifiant unique de la connexion. Vous pouvez utiliser cet identifiant de connexion pour explorer le stockage dans le cloud à l’aide de l’API Flow Service ou ingérer des données Parquet à l’aide de l’API Flow Service.

Sur cette page