Guida dell’API di Catalog Service
Catalog Service è il sistema di registrazione per la posizione e la derivazione dei dati in Adobe Experience Platform. Catalog funge da archivio o "catalogo" di metadati in cui è possibile trovare informazioni sui dati all’interno di Experience Platform, senza dover accedere ai dati stessi. Consulta la Catalog panoramica per ulteriori informazioni.
Questa guida per sviluppatori descrive i passaggi per iniziare a utilizzare l’API di Catalog. La guida fornisce quindi esempi di chiamate API per eseguire operazioni chiave tramite Catalog.
Prerequisiti
Catalog tiene traccia dei metadati per diversi tipi di risorse e operazioni in Experience Platform. Questa guida per sviluppatori richiede una buona conoscenza delle varie Experience Platform servizi coinvolti nella creazione e nella gestione di queste risorse:
- Experience Data Model (XDM): framework standardizzato per l’organizzazione dei dati sull’esperienza del cliente in Platform.
- Acquisizione in batch: Come Experience Platform acquisisce e memorizza dati da file di dati, come CSV e Parquet.
- Acquisizione in streaming: Come Experience Platform acquisisce e memorizza in tempo reale i dati da dispositivi lato client e lato server.
Le sezioni seguenti forniscono informazioni aggiuntive che è necessario conoscere o disporre di per effettuare correttamente chiamate al Catalog Service API.
Lettura delle chiamate API di esempio
Questa guida fornisce esempi di chiamate API per illustrare 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 gli esempi di chiamate API nella guida alla risoluzione dei problemi.di Experience Platform.
Raccogliere i valori per le intestazioni richieste
Per effettuare chiamate alle API di Platform, devi prima completare il tutorial sull’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 sono isolati 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 aggiuntiva:
- Content-Type: application/json
Best practice per Catalog Chiamate API
Quando si eseguono richieste di GET a Catalog API, la best practice consiste nell’includere parametri di query nelle richieste per restituire solo gli oggetti e le proprietà necessari. Le richieste non filtrate possono causare payload di risposta di dimensioni superiori a 3 GB, rallentando le prestazioni complessive.
Puoi visualizzare oggetti specifici includendo il loro ID nel percorso della richiesta o utilizzando parametri di query come properties e limit per filtrare le risposte. I filtri possono essere passati come intestazioni e come parametri di query, con quelli passati come parametri di query che hanno la precedenza. Vedi il documento su filtraggio dei dati catalogo per ulteriori informazioni.
Poiché alcune query possono comportare un carico pesante sull’API, i limiti globali sono stati implementati su Catalog query per supportare ulteriormente le best practice.
Passaggi successivi
Questo documento tratta le conoscenze preliminari necessarie per effettuare chiamate alle API di Catalog. Ora puoi passare alle chiamate di esempio fornite in questa guida per sviluppatori e seguire le relative istruzioni.
La maggior parte degli esempi contenuti in questa guida utilizza /dataSets endpoint, ma i principi possono essere applicati ad altri endpoint all’interno di Catalog (ad esempio /batches). Consulta la Riferimento API di Catalog Service per un elenco completo di tutte le chiamate e le operazioni disponibili per ciascun endpoint.
Per un flusso di lavoro dettagliato che dimostri come Catalog L’API è coinvolta nell’acquisizione dei dati; consulta l’esercitazione su creazione di un set di dati.