Questa esercitazione utilizza l’ API Flow Service per esplorare i contenuti e la struttura dei file di un database di terze parti.
Questa guida richiede una buona comprensione dei seguenti componenti di Adobe Experience Platform:
Le sezioni seguenti forniscono informazioni aggiuntive che sarà necessario conoscere per connettersi correttamente a un database di terze parti utilizzando l'API Flow Service.
Questa esercitazione richiede una connessione valida con il database di terze parti da cui si desidera acquisire i dati. Una connessione valida include l'ID delle specifiche di connessione del database e l'ID di connessione. Ulteriori informazioni sulla creazione di una connessione al database e sul recupero di tali valori sono disponibili nella panoramica dei connettori di origine.
Questa esercitazione fornisce esempi di chiamate API per dimostrare come formattare le richieste. Questi includono percorsi, intestazioni richieste e payload di richiesta formattati correttamente. Viene inoltre fornito un esempio di codice JSON restituito nelle risposte API. Per informazioni sulle convenzioni utilizzate nella documentazione per le chiamate API di esempio, consulta la sezione su come leggere le chiamate API di esempio nella guida alla risoluzione dei problemi di Experience Platform .
Per effettuare chiamate alle API Platform, devi prima completare l’ esercitazione sull’autenticazione. Il completamento dell'esercitazione di autenticazione fornisce i valori per ciascuna delle intestazioni richieste in tutte le chiamate API Experience Platform, come mostrato di seguito:
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {IMS_ORG}
Tutte le risorse in Experience Platform, comprese quelle appartenenti a Flow Service, sono isolate in sandbox virtuali specifiche. Tutte le richieste alle API Platform richiedono un’intestazione che specifichi 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 di tipo multimediale aggiuntiva:
Content-Type: application/json
Utilizzando l’ID di connessione per il database, è possibile esplorare le tabelle di dati eseguendo le richieste GET. Utilizza la seguente chiamata per trovare il percorso della tabella che desideri controllare o acquisire in 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: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Risposta
Una risposta corretta restituisce un array di tabelle dal database. Trova la tabella da inserire in Platform e prendi nota della relativa proprietà path
, in quanto devi fornirla nel passaggio successivo per ispezionarne 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 esaminare 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: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Risposta
Una risposta corretta restituisce la struttura della tabella specificata. I dettagli relativi a ciascuna colonna della tabella si trovano all’interno degli elementi della matrice columns
.
{
"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, trovato il percorso della tabella che desideri inserire in Platform e ottenuto informazioni sulla relativa struttura. Puoi utilizzare queste informazioni nell'esercitazione successiva per raccogliere dati dal database e inserirli in Platform.