Questa esercitazione utilizza Flow Service API per esplorare il contenuto e la struttura di file di un database di terze parti.
Questa guida richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:
Le sezioni seguenti forniscono informazioni aggiuntive che è necessario conoscere per connettersi correttamente a un database di terze parti utilizzando Flow Service API.
Questo tutorial richiede una connessione valida con il database di terze parti da cui desideri acquisire i dati. Una connessione valida include l'ID di specifica di connessione e l'ID di connessione del database. Per ulteriori informazioni sulla creazione di una connessione al database e sul recupero di questi valori, vedere panoramica dei connettori di origini.
Questo tutorial 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 il codice JSON di esempio restituito nelle risposte API. Per informazioni sulle convenzioni utilizzate nella documentazione per le chiamate API di esempio, consulta la sezione su come leggere esempi di chiamate API nel Experience Platform guida alla risoluzione dei problemi.
Per effettuare chiamate a Platform , devi prima completare le tutorial sull’autenticazione. Il completamento del tutorial sull’autenticazione fornisce i valori per ciascuna delle intestazioni richieste in tutte le Experience Platform Chiamate API, come mostrato di seguito:
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {ORG_ID}
Tutte le risorse in Experience Platform, compresi quelli appartenenti a Flow Service, sono isolate in specifiche sandbox virtuali. Tutte le richieste a Platform Le API richiedono un’intestazione che specifichi 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 di tipo multimediale aggiuntiva:
Content-Type: application/json
Utilizzando l’ID di connessione per il database, puoi esplorare le tabelle di dati eseguendo richieste GET. Utilizza la seguente chiamata per trovare il percorso della tabella da ispezionare o in cui desideri acquisire Platform.
Formato API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
Parametro | Descrizione |
---|---|
{BASE_CONNECTION_ID} |
ID di connessione dell'origine del database. |
Richiesta
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/explore?objectType=root' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Risposta
In caso di esito positivo, la risposta restituisce una matrice di tabelle dal database. Trova la tabella da inserire in Platform e ne prende atto path
come è necessario fornirlo nel passaggio successivo per esaminarne la struttura.
[
{
"type": "table",
"name": "test1.Mytable",
"path": "test1.Mytable",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "test1.austin_demo",
"path": "test1.austin_demo",
"canPreview": true,
"canFetchSchema": true
}
]
Per controllare la struttura di una tabella dal database, eseguire una richiesta di GET specificando il percorso di una tabella come parametro di query.
Formato API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}
Parametro | Descrizione |
---|---|
{BASE_CONNECTION_ID} |
ID di una connessione al database. |
{TABLE_PATH} |
Percorso di una tabella. |
Richiesta
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/explore?objectType=table&object=test1.Mytable' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Risposta
In caso di esito positivo, la risposta restituisce la struttura della tabella specificata. I dettagli relativi a ciascuna colonna della tabella si trovano all’interno di elementi della sezione columns
array.
{
"format": "flat",
"schema": {
"columns": [
{
"name": "TestID",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Name",
"type": "string",
"xdm": {
"type": "string"
}
}
]
}
}
Seguendo questa esercitazione, hai esplorato il database e trovato il percorso della tabella in cui desideri acquisire Platforme ha ottenuto informazioni sulla sua struttura. Queste informazioni sono disponibili nell'esercitazione successiva per raccogliere dati dal database e inserirli in Platform.