Show Menu
ARGOMENTI×

Esplora un sistema di archiviazione cloud utilizzando l'API del servizio di flusso

Flow Service è utilizzato per raccogliere e centralizzare i dati dei clienti da varie origini diverse 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’API del servizio di flusso per esplorare un sistema di archiviazione cloud di terze parti.

Introduzione

Questa guida richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:
  • Origini : Experience Platform consente di acquisire dati da varie fonti, fornendo al contempo la possibilità di strutturare, etichettare e migliorare i dati in arrivo tramite i servizi della piattaforma.
  • Sandbox : Experience Platform fornisce sandbox virtuali che dividono una singola istanza della piattaforma 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 sistema di archiviazione cloud utilizzando l'API del servizio di flusso.

Ottenere una connessione di base

Per esplorare un archivio cloud di terze parti utilizzando le API della piattaforma, è necessario possedere un ID di connessione di base valido. Se non si dispone già di una connessione di base per l'archivio con cui si desidera lavorare, è possibile crearne una tramite le seguenti esercitazioni:

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

Raccogli valori per le intestazioni richieste

Per effettuare chiamate alle API della piattaforma, dovete prima completare l'esercitazione di autenticazione. Completando l'esercitazione sull'autenticazione, vengono forniti i valori per ciascuna delle intestazioni richieste in tutte le chiamate API di Experience Platform, 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, incluse quelle appartenenti a Flow Service, sono isolate in sandbox virtuali specifiche. Tutte le richieste alle API della piattaforma 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

Esplora l'archiviazione cloud

Utilizzando la connessione di base per l'archiviazione cloud, potete esplorare file e directory eseguendo richieste GET. Quando si eseguono richieste GET per esplorare l'archiviazione cloud, è necessario includere i parametri di query elencati nella tabella seguente:
Parametro
Descrizione
objectType
Il tipo di oggetto che si desidera esplorare. Imposta questo valore come:
  • folder : Esplora una directory specifica
  • root : Esplora la directory principale.
object
Questo parametro è richiesto solo quando si visualizza una directory specifica. Il suo valore rappresenta il percorso della directory che desiderate esplorare.
Utilizzate la seguente chiamata per trovare il percorso del file che desiderate portare in Piattaforma:
Formato API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=folder&object={PATH}

Parametro
Descrizione
{BASE_CONNECTION_ID}
ID di una connessione di base per l'archiviazione cloud.
{PATH}
Percorso di una directory.
Richiesta
curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/{BASE_CONNECTION_ID}/explore?objectType=folder&object=/some/path/' \
    -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}'

Risposta
Una risposta corretta restituisce un array di file e cartelle presenti nella directory interrogata. Prendete nota della path proprietà del file che desiderate caricare, in quanto dovete fornire al passaggio successivo per ispezionarne la struttura.
[
    {
        "type": "File",
        "name": "data.csv",
        "path": "/some/path/data.csv"
    },
    {
        "type": "Folder",
        "name": "foobar",
        "path": "/some/path/foobar"
    }
]

Esaminare la struttura di un file

Per esaminare la struttura del file di dati dall'archivio cloud, eseguite una richiesta GET fornendo il percorso del file come parametro di query.
Formato API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&fileType={FILE_TYPE}

Parametro
Descrizione
{BASE_CONNECTION_ID}
ID di una connessione di base per l'archiviazione cloud.
{FILE_PATH}
Percorso di un file.
{FILE_TYPE}
Il tipo di file. I tipi di file supportati includono:
  • DELIMITATO: Valore separato da delimitatore. I file DSV devono essere separati da virgole.
  • JSON: Notazione oggetto JavaScript. I file JSON devono essere conformi a XDM
  • PARQUET: Parquet Apache. I file parquet devono essere conformi a XDM.
Richiesta
curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/{BASE_CONNECTION_ID}/explore?objectType=file&object=/some/path/data.csv&fileType=DELIMITED' \
    -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}'

Risposta
Una risposta corretta restituisce la struttura del file interrogato, inclusi i nomi di tabella e i tipi di dati.
[
    {
        "name": "Id",
        "type": "String"
    },
    {
        "name": "FirstName",
        "type": "String"
    },
    {
        "name": "LastName",
        "type": "String"
    },
    {
        "name": "Email",
        "type": "String"
    },
    {
        "name": "Phone",
        "type": "String"
    }
]

Passaggi successivi

Seguendo questa esercitazione, hai esplorato il sistema di storage cloud, trovato il percorso del file che desideri portare in Piattaforma e ne hai visualizzato la struttura. Potete utilizzare queste informazioni nell'esercitazione successiva per raccogliere i dati dall'archiviazione cloud e portarli nella piattaforma .