Creare una connessione sorgente FTP utilizzando l'API Flow Service

NOTA

Il connettore FTP è in versione beta. Le funzioni e la documentazione sono soggette a modifiche. Per ulteriori informazioni sull'utilizzo dei connettori con etichetta beta, vedere Panoramica delle sorgenti.

Questa esercitazione utilizza l'API Flow Service per guidarti attraverso i passaggi necessari per connettersi Experience Platform a un server FTP (File Transfer Protocol).

Introduzione

Questa guida richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:

  • Origini: Experience Platform consente l'acquisizione di dati da varie origini, fornendo al contempo la possibilità di strutturare, etichettare e migliorare i dati in arrivo tramite Platform i servizi.
  • Sandbox: Experience Platform fornisce sandbox virtuali che dividono una singola Platform istanza in ambienti virtuali separati per sviluppare e sviluppare applicazioni per esperienze digitali.

Le sezioni seguenti forniscono informazioni aggiuntive che sarà necessario conoscere per collegarsi correttamente a un server FTP utilizzando l'API Flow Service.

Raccogli credenziali richieste

Affinché Flow Service possa connettersi all'FTP, è necessario fornire valori per le seguenti proprietà di connessione:

Credenziali Descrizione
host Nome o indirizzo IP associato al server FTP.
username Il nome utente con accesso al server FTP.
password La password per il server FTP.

Lettura di chiamate API di esempio

Questa esercitazione fornisce esempi di chiamate API per dimostrare come formattare le richieste. Questi includono percorsi, intestazioni richieste e payload di richieste formattati correttamente. Viene inoltre fornito un JSON di esempio restituito nelle risposte API. Per informazioni sulle convenzioni utilizzate nella documentazione per le chiamate API di esempio, consultate la sezione relativa a come leggere chiamate API di esempio nella guida alla risoluzione dei problemi di Experience Platform.

Raccogli valori per le intestazioni richieste

Per effettuare chiamate alle Platform API, è innanzitutto necessario completare l'esercitazione sull'autenticazione a2/>. Completando l'esercitazione sull'autenticazione, vengono forniti i valori per ciascuna delle intestazioni richieste in tutte le chiamate API Experience Platform, come illustrato di seguito:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Tutte le risorse in Experience Platform, incluse quelle appartenenti a Flow Service, sono isolate in sandbox virtuali specifiche. Tutte le richieste alle Platform API richiedono un'intestazione che specifica il nome della sandbox in cui verrà eseguita l'operazione:

  • x-sandbox-name: {SANDBOX_NAME}

Tutte le richieste che contengono un payload (POST, PUT, PATCH) richiedono un'intestazione aggiuntiva per il tipo di supporto:

  • Content-Type: application/json

Creare una connessione

Una connessione specifica un'origine e contiene le credenziali per tale origine. È necessaria una sola connessione per account FTP, in quanto può essere utilizzata per creare più connettori sorgente per inserire dati diversi.

Creazione di una connessione FTP tramite autenticazione di base

Per creare una connessione FTP utilizzando l'autenticazione di base, effettuare una richiesta POST all'API Flow Service fornendo al contempo i valori per le connessioni host, userName e password.

Formato API

POST /connections

Richiesta

Per creare una connessione FTP, è necessario fornire l'ID univoco della specifica di connessione come parte della richiesta POST. L'ID della specifica di connessione per l'FTP è fb2e94c9-c031-467d-8103-6bd6e0a432f2.

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"
        }
    }'
Proprietà Descrizione
auth.params.host Il nome host del server FTP.
auth.params.username Nome utente associato al server FTP.
auth.params.password La password associata al server FTP.
connectionSpec.id ID specifica connessione server FTP: fb2e94c9-c031-467d-8103-6bd6e0a432f2

Risposta

Una risposta corretta restituisce l'identificatore univoco (id) della connessione appena creata. Questo ID è necessario per esplorare il server FTP nell'esercitazione successiva.

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

Passaggi successivi

Seguendo questa esercitazione, hai creato una connessione FTP utilizzando l'API Flow Service e hai ottenuto il valore ID univoco della connessione. Puoi utilizzare questo ID connessione per esplorare gli archivi cloud utilizzando l'API del servizio di flusso o i dati del parquet di acquisizione tramite l'API del servizio di flusso.

In questa pagina