Creare una connessione base 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, consulta la Panoramica delle sorgenti .

Una connessione di base rappresenta la connessione autenticata tra un'origine e Adobe Experience Platform.

Questa esercitazione descrive i passaggi necessari per creare una connessione di base per FTP (File Transfer Protocol) utilizzando l' Flow Service API.

Introduzione

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

  • Origini: Experience Platform consente l’acquisizione di dati da varie sorgenti, 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 suddividono una singola Platform istanza in ambienti virtuali separati per sviluppare e sviluppare applicazioni di esperienza digitale.

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

Raccogli credenziali richieste

Affinché Flow Service possa connettersi a FTP, è necessario fornire i 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 Password per il server FTP.
connectionSpec.id La specifica di connessione restituisce le proprietà del connettore di un'origine, incluse le specifiche di autenticazione relative alla creazione delle connessioni di base e di origine. L'ID della specifica di connessione per FTP è: fb2e94c9-c031-467d-8103-6bd6e0a432f2.

Utilizzo delle API di Platform

Per informazioni su come effettuare correttamente le chiamate alle API di Platform, consulta la guida guida introduttiva alle API di Platform .

Creare una connessione di base

Una connessione di base conserva le informazioni tra l'origine e la piattaforma, incluse le credenziali di autenticazione dell'origine, lo stato corrente della connessione e l'ID di connessione di base univoco. L’ID di connessione di base consente di esplorare e navigare tra i file di origine e di identificare gli elementi specifici da acquisire, comprese le informazioni relative ai tipi di dati e ai formati corrispondenti.

Per creare un ID di connessione di base, invia una richiesta POST all'endpoint /connections fornendo le credenziali di autenticazione FTP come parte dei parametri della richiesta.

Formato API

POST /connections

Richiesta

La seguente richiesta crea una connessione di base per 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"
        }
    }'
Proprietà Descrizione
auth.params.host Il nome host del server FTP.
auth.params.username Nome utente associato al server FTP.
auth.params.password Password associata al server FTP.
connectionSpec.id ID delle specifiche di connessione del server FTP: fb2e94c9-c031-467d-8103-6bd6e0a432f2

Risposta

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

{
    "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 acquisire i dati del parquet utilizzando l'API del servizio di flusso.

In questa pagina