Catalog Service Guida all’API

Catalog Service è il sistema di registrazione per la posizione e la derivazione dei dati in Adobe Experience Platform. Catalog funge da archivio di metadati o "catalogo" in cui è possibile trovare informazioni sui dati all’interno di Experience Platform, senza dover accedere ai dati stessi. Per ulteriori informazioni, consulta la sezione Catalog panoramica .

Questa guida per gli sviluppatori descrive i passaggi necessari per iniziare a utilizzare l’ API Catalog . La guida fornisce quindi un esempio di chiamate API per eseguire operazioni chiave utilizzando Catalog.

Prerequisiti

Catalog tiene traccia dei metadati per diversi tipi di risorse e operazioni all’interno di Experience Platform. Questa guida per gli sviluppatori richiede una buona comprensione dei vari servizi Experience Platform coinvolti nella creazione e gestione di queste risorse:

  • Experience Data Model (XDM): Il framework standardizzato in base al quale Platform vengono organizzati i dati sulla customer experience.
  • Acquisizione batch: Come Experience Platform acquisisce e memorizza i dati dai file di dati, come CSV e Parquet.
  • Acquisizione in streaming: Come Experience Platform acquisire e memorizzare in tempo reale i dati da dispositivi lato client e lato server.

Le sezioni seguenti forniscono informazioni aggiuntive che dovrai conoscere o disporre di a tua disposizione per effettuare correttamente le chiamate all’ API Catalog Service .

Lettura di chiamate API di esempio

Questa guida 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 .

Raccogli i valori delle intestazioni richieste

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:

  • Autorizzazione: Portatore {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Tutte le risorse in Experience Platform 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:

  • nome x-sandbox: {SANDBOX_NAME}
NOTA

Per ulteriori informazioni sulle sandbox in Platform, consulta la documentazione di panoramica sandbox.

Tutte le richieste che contengono un payload (POST, PUT, PATCH) richiedono un’intestazione aggiuntiva:

  • Tipo di contenuto: application/json

Best practice per le chiamate API Catalog

Quando si eseguono richieste GET all'API Catalog, è consigliabile includere nelle richieste i parametri di query al fine di restituire solo gli oggetti e le proprietà necessari. Le richieste non filtrate possono causare il raggiungimento da parte dei payload di risposta di dimensioni superiori a 3 GB, il che può rallentare le prestazioni complessive.

Puoi visualizzare oggetti specifici includendo il loro ID nel percorso della richiesta o utilizzare 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. Per ulteriori informazioni, consulta il documento sul filtraggio dei dati del catalogo .

Poiché alcune query possono caricare notevolmente l’API, sono stati implementati limiti globali sulle query Catalog per supportare ulteriormente le best practice.

Passaggi successivi

Questo documento tratta le conoscenze preliminari necessarie per effettuare chiamate all’ API Catalog . Ora puoi passare alle chiamate di esempio fornite in questa guida per gli sviluppatori e seguire le relative istruzioni.

La maggior parte degli esempi in questa guida utilizza l’endpoint /dataSets, ma i principi possono essere applicati ad altri endpoint all’interno di Catalog (ad esempio /batches e /accounts). Per un elenco completo di tutte le chiamate e le operazioni disponibili per ciascun endpoint, consulta Riferimento API del servizio catalogo .

Per un flusso di lavoro dettagliato che illustra come l’ Catalog API è coinvolta nell’inserimento dei dati, consulta l’esercitazione su creazione di un set di dati.

In questa pagina

Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now