Lettura delle chiamate API di esempio
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 un 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 chiamate API di esempio nella guida alla risoluzione dei problemi di Experience Platform.
Raccogliere i valori per le intestazioni richieste
Per effettuare chiamate alle API Experience Platform, devi prima completare l'esercitazione di autenticazione. Completando il tutorial sull’autenticazione si ottengono i valori per ciascuna delle intestazioni richieste in tutte le chiamate API di Experience Platform, come mostrato di seguito:
- Autorizzazione: Bearer
{ACCESS_TOKEN} - x-api-key:
{API_KEY} - x-gw-ims-org-id:
{ORG_ID}
Tutte le risorse in Experience Platform, incluse quelle appartenenti a Flow Service, sono isolate in sandbox virtuali specifiche. Tutte le richieste alle API Experience Platform 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:
- Tipo di contenuto:
application/json
Esplora le tabelle di dati
Utilizzando la connessione di base per il sistema di automazione marketing, puoi esplorare le tabelle di dati eseguendo richieste GET. Utilizzare la seguente chiamata per trovare il percorso della tabella da controllare o acquisire in Experience Platform.
Formato API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
| Parametro | Descrizione |
|---|---|
{BASE_CONNECTION_ID} | ID della connessione di base per il sistema di automazione marketing. |
Richiesta
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/2fce94c1-9a93-4971-8e94-c19a93097129/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
Una risposta corretta è un array di tabelle da al sistema di automazione marketing. Individuare la tabella che si desidera inserire in Experience Platform e prendere nota della relativa proprietà path, in quanto è necessario fornirla nel passaggio successivo per esaminarne la struttura.
[
{
"type": "table",
"name": "Hubspot.All_Deals",
"path": "Hubspot.All_Deals",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Hubspot.Blog_Authors",
"path": "Hubspot.Blog_Authors",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Hubspot.Blog_Comments",
"path": "Hubspot.Blog_Comments",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Hubspot.Contacts",
"path": "Hubspot.Contacts",
"canPreview": true,
"canFetchSchema": true
},
]
Controllare la struttura di una tabella
Per controllare la struttura di una tabella dal sistema di automazione marketing, esegui una richiesta 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 connessione per il sistema di automazione marketing. |
{TABLE_PATH} | Percorso di una tabella all’interno del sistema di automazione marketing. |
Richiesta
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/2fce94c1-9a93-4971-8e94-c19a93097129/explore?objectType=table&object=Hubspot.Contacts' \
-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 di una tabella. I dettagli relativi a ciascuna colonna della tabella si trovano all'interno di elementi dell'array columns.
{
"format": "flat",
"schema": {
"columns": [
{
"name": "Properties_Firstname_Value",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Properties_Lastname_Value",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Added_At",
"type": "string",
"meta:xdmType": "date-time",
"xdm": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Portal_Id",
"type": "string",
"xdm": {
"type": "string"
}
},
]
}
}
Passaggi successivi
Seguendo questa esercitazione, hai esplorato il tuo sistema di automazione marketing, trovato il percorso della tabella che desideri portare in Experience Platform e ottenuto informazioni relative alla sua struttura. Puoi utilizzare queste informazioni nel prossimo tutorial per raccogliere dati dal tuo sistema di automazione marketing e inserirli in Experience Platform.
Experience Platform
