Guida dell’API di Schema Registry

L’ Schema Registry viene utilizzato per accedere alla libreria dello schema in Adobe Experience Platform, fornendo un’interfaccia utente e un’API RESTful da cui sono accessibili tutte le risorse della libreria disponibili.

L’API del Registro di sistema dello schema fornisce diversi endpoint che ti consentono di gestire in modo programmatico tutti gli schemi e le relative risorse Experience Data Model (XDM) disponibili all’interno di Platform. Ciò include quelli definiti da Adobe, Experience Platform partner e fornitori le cui applicazioni utilizzi.

Questi endpoint sono descritti di seguito. Per informazioni dettagliate, visita le singole guide dell'endpoint e fai riferimento alla guida introduttiva per informazioni importanti sulle intestazioni richieste, sulla lettura di chiamate API di esempio e altro ancora.

IMPORTANTE

XDM utilizza la formattazione dello schema JSON per descrivere e convalidare la struttura dei dati sulla customer experience acquisiti. Prima di utilizzare l'API del Registro di sistema dello schema, si consiglia vivamente di consultare la documentazione ufficiale dello schema JSON per una migliore comprensione di questa tecnologia di base.

Per visualizzare tutti gli endpoint disponibili e le operazioni CRUD, visita il riferimento API del Registro di sistema dello schema.

Schemi

Gli schemi XDM rappresentano e convalidano la struttura e il formato dei dati acquisiti in Platform. Uno schema è composto da una classe e da zero o più gruppi di campi dello schema. Puoi creare, visualizzare, modificare ed eliminare gli schemi utilizzando l’endpoint /schemas. Per informazioni su come utilizzare questo endpoint, consulta la guida all’endpoint degli schemi.

Per una guida dettagliata su come creare uno schema completo nell’API del Registro di sistema dello schema, inclusa la creazione e l’aggiunta di gruppi di campi e tipi di dati, consulta l’ esercitazione sulla creazione dello schema API.

Comportamenti

I comportamenti definiscono la natura dei dati descritti da uno schema. Ogni classe XDM deve fare riferimento a un comportamento specifico che tutti gli schemi che utilizzano tale classe erediteranno. Per informazioni su come visualizzare i comportamenti disponibili nell’API, consulta la guida dell’endpoint per i comportamenti .

Classi

Una classe definisce la struttura di base delle proprietà comuni che devono contenere tutti gli schemi basati su tale classe e determina quali gruppi di campi sono idonei per essere utilizzati in tali schemi. Ogni classe deve essere associata a un comportamento esistente. Per informazioni dettagliate sulle operazioni con le classi nell'API, consulta la guida endpoint classi .

Gruppi di campi

I gruppi di campi sono componenti riutilizzabili che definiscono uno o più campi che rappresentano un concetto particolare, ad esempio una singola persona, un indirizzo di posta o un ambiente browser web. I gruppi di campi sono destinati a essere inclusi come parte di uno schema che implementa una classe compatibile, a seconda del comportamento dei dati che rappresentano (record o serie temporali). Per informazioni su come lavorare con i gruppi di campi nell’API, consulta la guida endpoint dei gruppi di campi .

Tipi di dati

I tipi di dati vengono utilizzati come campi di tipo riferimento nelle classi o nei gruppi di campi allo stesso modo dei campi letterali di base, con una differenza chiave che consiste nel fatto che i tipi di dati possono definire più campi secondari. Sebbene siano simili ai gruppi di campi in quanto consentono un uso coerente di una struttura a più campi, i tipi di dati sono più flessibili perché possono essere inclusi in qualsiasi punto della struttura dello schema, mentre i gruppi di campi possono essere aggiunti solo a livello principale. Per ulteriori informazioni sulle operazioni con i tipi di dati nell'API, consulta la guida endpoint per i tipi di dati .

Descrittori

I descrittori sono set di metadati assegnati a campi specifici all’interno di uno schema, che forniscono vari dettagli contestuali, tra cui il modo in cui tali campi (e lo schema stesso) sono correlati ad altri schemi. A ogni schema può essere applicata una o più entità descrittore e sono disponibili diversi tipi di descrittori per scopi diversi. Per ulteriori informazioni sulle operazioni con i descrittori nell'API, consulta la guida all'endpoint dei descrittori e una panoramica dei diversi tipi di descrittori e dei relativi casi d'uso.

Unioni

Platform consente di comporre schemi per casi d’uso particolari, ma consente anche di comporre un’"unione" di schemi appartenenti a una classe specifica. Uno schema di unione aggrega i campi di tutti gli schemi che condividono la stessa classe in un’unica rappresentazione. Attivando uno schema da utilizzare con Profilo cliente in tempo reale, tale schema viene incluso nell'unione per la relativa classe. Di conseguenza, gli schemi di unione non possono essere modificati direttamente e possono essere interessati solo dall’inclusione o dall’esclusione di schemi da utilizzare in Profilo.

Per informazioni su come visualizzare i sindacati nell'API del Registro di sistema dello schema, consulta la guida all'endpoint dei sindacati.

Esporta/Importa

L’API del Registro di sistema dello schema consente di trasferire e condividere risorse XDM tra sandbox e organizzazioni IMS. Per qualsiasi schema, gruppo di campi o tipo di dati, puoi generare un payload di esportazione contenente la struttura della risorsa e le risorse dipendenti. Questo payload può quindi essere utilizzato per importare la risorsa in una sandbox di destinazione e in un’organizzazione IMS.

Per ulteriori informazioni sull’utilizzo di questi endpoint, consulta la guida all’esportazione/importazione .

Dati di esempio

È possibile generare dati di esempio per qualsiasi schema specificato nella Libreria schema. L’oggetto di risposta restituito può quindi essere utilizzato come origine dell’inserimento dei dati.

Per ulteriori informazioni sull'utilizzo di questo endpoint, consulta la guida per l'endpoint di dati di esempio .

Registro di controllo

Il Registro di sistema dello schema mantiene un registro di tutte le modifiche apportate a una risorsa (classe, gruppo di campi, tipo di dati o schema) tra diversi aggiornamenti. Puoi recuperare il registro per una particolare risorsa fornendo il relativo $id o meta:altId nel percorso di una richiesta di GET a questo endpoint.

Per ulteriori informazioni sull’utilizzo di questo endpoint, consulta la guida dell’endpoint del registro di controllo .

Passaggi successivi

Per iniziare a effettuare chiamate utilizzando l’API Schema Registry, leggi la guida introduttiva e seleziona una delle guide degli endpoint per capire come utilizzare endpoint specifici.

In questa pagina