Show Menu
ARGOMENTI×

Creare un connettore SFTP utilizzando l' Flow Service API

Il connettore SFTP è 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 Termini e condizioni Origini.
Flow Service viene utilizzato per raccogliere e centralizzare i dati dei clienti da varie origini all'interno di Adobe Experience Platform. Il servizio fornisce un'interfaccia utente e RESTful API da cui sono collegate tutte le origini supportate.
Questa esercitazione utilizza l' Flow Service API per guidarvi attraverso i passaggi necessari per la connessione Experience Platform a un server SFTP (Secure File Transfer Protocol).
Se preferite utilizzare l'interfaccia utente in Experience Platform, l'esercitazione Creare un connettore sorgente FTP o SFTP nell’interfaccia utente UI fornisce istruzioni dettagliate per eseguire azioni simili.

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 SFTP utilizzando l' Flow Service API.

Raccogli credenziali richieste

Per poter Flow Service connettersi a SFTP, è necessario fornire valori per le seguenti proprietà di connessione:
Credenziali
Descrizione
host
Nome o indirizzo IP associato al server SFTP.
username
Il nome utente con accesso al server SFTP.
password
La password per il server SFTP.
privateKeyContent
Il contenuto della chiave privata SSH con codifica Base64. Formato della chiave privata SSH OpenSSH (RSA/DSA).
passPhrase
La frase di autorizzazione o la password per decifrare la chiave privata se il file chiave o il contenuto chiave sono protetti da una frase di autorizzazione. Se PrivateKeyContent è protetto da password, questo parametro deve essere utilizzato con la passphrase PrivateKeyContent come valore.

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, vedete la sezione come leggere chiamate API di esempio nella guida alla Experience Platform risoluzione dei problemi.

Raccogli valori per le intestazioni richieste

Per effettuare chiamate alle Platform API, è prima necessario completare l'esercitazione sull' autenticazione. Completando l'esercitazione sull'autenticazione, vengono forniti i valori per ciascuna delle intestazioni richieste in tutte le chiamate Experience Platform API, come illustrato di seguito:
  • Autorizzazione: Portatore {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Tutte le risorse in Experience Platform, comprese quelle appartenenti al gruppo 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 avrà luogo 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 SFTP, in quanto può essere utilizzata per creare più connettori sorgente per inserire dati diversi.

Creazione di una connessione SFTP tramite autenticazione di base

Per creare una connessione SFTP utilizzando l'autenticazione di base, effettua una richiesta POST all' Flow Service API fornendo al contempo i valori per la connessione host , userName e password .
Formato API
POST /connections

Richiesta
curl -X POST \
    'http://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  "auth": {
        "specName": "Basic Authentication for sftp",
        "params": {
            "host": "{HOST_NAME}",
            "userName": "{USER_NAME}",
            "password": "{PASSWORD}"
        }
    },
    "connectionSpec": {
        "id": "b7bf2577-4520-42c9-bae9-cad01560f7bc",
        "version": "1.0"
    }
}

Proprietà
Descrizione
auth.params.host
Il nome host del server SFTP.
auth.params.username
Nome utente associato al server SFTP.
auth.params.password
La password associata al server SFTP.
connectionSpec.id
ID specifica connessione server SFTP: b7bf2577-4520-42c9-bae9-cad01560f7bc
Risposta
Una risposta corretta restituisce l’identificatore univoco ( id ) della connessione appena creata. Questo ID è necessario per esplorare il server SFTP nell'esercitazione successiva.
{
    "id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
    "etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}

Creare una connessione SFTP utilizzando l'autenticazione a chiave pubblica SSH

Per creare una connessione SFTP utilizzando l'autenticazione a chiave pubblica SSH, effettua una richiesta POST all' Flow Service API fornendo al contempo valori per la connessione host , userName , privateKeyContent e passPhrase .
Formato API
POST /connections

Richiesta
curl -X POST \
    'http://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  "auth": {
        "specName": "SSH PublicKey Authentication for sftp",
        "params": {
            "host": "{HOST_NAME}",
            "userName": "{USER_NAME}",
            "privateKeyContent": "{PRIVATE_KEY_CONTENT}",
            "passPhrase": "{PASS_PHRASE}"
        }
    },
    "connectionSpec": {
        "id": "b7bf2577-4520-42c9-bae9-cad01560f7bc",
        "version": "1.0"
    }
}

Proprietà
Descrizione
auth.params.host
Il nome host del server SFTP.
auth.params.username
Nome utente associato al server SFTP.
auth.params.privateKeyContent
Il contenuto della chiave privata SSH con codifica base64. Formato della chiave privata SSH OpenSSH (RSA/DSA).
auth.params.passPhrase
La frase di autorizzazione o la password per decifrare la chiave privata se il file chiave o il contenuto chiave sono protetti da una frase di autorizzazione. Se PrivateKeyContent è protetto da password, questo parametro deve essere utilizzato con la passphrase PrivateKeyContent come valore.
connectionSpec.id
ID specifica connessione server SFTP: b7bf2577-4520-42c9-bae9-cad01560f7bc
Risposta
Una risposta corretta restituisce l’identificatore univoco ( id ) della connessione appena creata. Questo ID è necessario per esplorare il server SFTP nell'esercitazione successiva.
{
    "id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
    "etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}

Passaggi successivi

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