Creare una connessione di base SFTP utilizzando Flow Service API

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 SFTP (Secure File Transfer Protocol) utilizzando Flow Service API.

Introduzione

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

  • Origini: L’Experience Platform consente di acquisire dati da varie sorgenti e allo stesso tempo di strutturare, etichettare e migliorare i dati in arrivo tramite i servizi Platform.
  • Sandbox: Experience Platform fornisce sandbox virtuali che suddividono una singola istanza di Platform in ambienti virtuali separati per sviluppare e sviluppare applicazioni di esperienza digitale.
IMPORTANTE

Si consiglia di evitare la restituzione di nuove righe o carrelli durante l’acquisizione di oggetti JSON con un SFTP connessione di origine. Per aggirare il limite, utilizza un singolo oggetto JSON per riga e utilizza più righe per i file successivi.

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

Raccogli credenziali richieste

Per Flow Service per connettersi a SFTP, è necessario fornire valori per le seguenti proprietà di connessione:

Credenziali Descrizione
host Nome o indirizzo IP associato al tuo SFTP server.
port La porta server SFTP a cui ti connetti. Se non viene fornito, il valore predefinito è 22.
username Il nome utente con accesso al tuo SFTP server.
password La password SFTP server.
privateKeyContent Contenuto della chiave privata SSH codificata Base64. Il tipo di chiave OpenSSH deve essere classificato come RSA o DSA.
passPhrase La frase o password per decrittografare la chiave privata se il file di chiave o il contenuto della chiave sono protetti da una frase di passaggio. Se la privateKeyContent è protetto da password, questo parametro deve essere utilizzato con la passphrase del contenuto della chiave privata come valore.
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. ID della specifica di connessione per SFTP è: b7bf2577-4520-42c9-bae9-cad01560f7bc.

Utilizzo delle API di Platform

Per informazioni su come effettuare correttamente le chiamate alle API di Platform, consulta la guida su 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 al /connections l'endpoint durante la fornitura del SFTP credenziali di autenticazione come parte dei parametri della richiesta.

Crea un SFTP connessione di base tramite autenticazione di base

Per creare un SFTP connessione di base utilizzando l’autenticazione di base, effettuare una richiesta di POST al Flow Service API fornendo al contempo i valori per la connessione host, userNamee password.

Formato API

POST /connections

Richiesta

La richiesta seguente crea una connessione di base per SFTP utilizzo dell’autenticazione di 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"
        }
    }'
Proprietà Descrizione
auth.params.host Il nome host del server SFTP.
auth.params.username Nome utente associato al server SFTP.
auth.params.password Password associata al server SFTP.
connectionSpec.id ID delle specifiche di connessione del server SFTP: b7bf2577-4520-42c9-bae9-cad01560f7bc

Risposta

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

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

Crea un SFTP connessione di base tramite autenticazione a chiave pubblica SSH

Per creare un SFTP connessione di base utilizzando l’autenticazione a chiave pubblica SSH, effettuare una richiesta POST al Flow Service API fornendo al contempo i valori per la connessione host, userName, privateKeyContente passPhrase.

IMPORTANTE

La SFTP Il connettore supporta una chiave OpenSSH di tipo RSA o DSA. Assicurati che il contenuto del tuo file chiave inizi con "-----BEGIN [RSA/DSA] PRIVATE KEY-----" e termina con "-----END [RSA/DSA] PRIVATE KEY-----". Se il file della chiave privata è un file in formato PPK, utilizza lo strumento PuTTY per convertire da PPK a formato OpenSSH.

Formato API

POST /connections

Richiesta

La richiesta seguente crea una connessione di base per SFTP utilizzo dell’autenticazione a chiave pubblica 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"
        }
    }'
Proprietà Descrizione
auth.params.host Il nome host del tuo SFTP server.
auth.params.username Il nome utente associato al tuo SFTP server.
auth.params.privateKeyContent Contenuto della chiave privata SSH codificata Base64. Il tipo di chiave OpenSSH deve essere classificato come RSA o DSA.
auth.params.passPhrase La frase o password per decrittografare la chiave privata se il file di chiave o il contenuto della chiave sono protetti da una frase di passaggio. Se PrivateKeyContent è protetto da password, questo parametro deve essere utilizzato con la passphrase PrivateKeyContent come valore.
connectionSpec.id La SFTP ID specifica connessione server: b7bf2577-4520-42c9-bae9-cad01560f7bc

Risposta

Una risposta corretta restituisce l'identificatore univoco (id) della nuova connessione creata. Questo ID è necessario per esplorare il tuo SFTP nel tutorial successivo.

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

Passaggi successivi

Seguendo questa esercitazione, hai creato un SFTP connessione tramite Flow Service e hanno ottenuto il valore ID univoco della connessione. Puoi usare questo ID connessione per esplorare gli archivi cloud utilizzando l’API del servizio di flusso.

In questa pagina