Schema Registry Guida per gli sviluppatori di API

Schema Registry viene utilizzato per accedere alla libreria Schema all'interno di Adobe Experience Platform, fornendo un'interfaccia utente e RESTful API da cui sono accessibili tutte le risorse libreria disponibili.

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

Tali punti finali sono descritti di seguito. Per informazioni dettagliate, visitate le singole guide degli endpoint e fate 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 esperienza cliente acquisiti. Prima di lavorare con 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 sottostante.

Per visualizzare tutti gli endpoint e le operazioni CRUD disponibili, visitare 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ù mixin. Potete creare, visualizzare, modificare ed eliminare gli schemi utilizzando l'endpoint /schemas. Per ulteriori informazioni sull'utilizzo di questo endpoint, vedere la guida dell'endpoint degli schemi.

Per una guida dettagliata su come creare uno schema completo nell'API del Registro di sistema dello schema, compresa la creazione e l'aggiunta di mixin e tipi di dati, vedere l' esercitazione sulla creazione dello schema API.

Comportamenti

I comportamenti definiscono la natura dei dati che uno schema descrive. 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, vedere la guida dell'endpoint di comportamento.

Classi

Una classe definisce la struttura di base delle proprietà comuni che devono contenere tutti gli schemi basati su tale classe e determina quali mixin possono essere utilizzati in tali schemi. Ogni classe deve essere associata a un comportamento esistente. Per informazioni sull'utilizzo delle classi nell'API, vedere la guida endpoint delle classi.

Mixin

I mix sono componenti riutilizzabili che definiscono uno o più campi che rappresentano un concetto particolare, ad esempio una singola persona, un indirizzo postale o un ambiente browser Web. Le mixine devono essere incluse come parte di uno schema che implementa una classe compatibile, a seconda del comportamento dei dati che rappresentano (record o serie temporali). Per informazioni sull'utilizzo dei mixin nelle API, vedere la guida dell'endpoint dei mixin.

Tipi di dati

I tipi di dati vengono utilizzati come campi di tipo riferimento nelle classi o nei mixin allo stesso modo dei campi letterali di base, con la differenza chiave che i tipi di dati possono definire più sottocampi. Anche se simili ai mixin in quanto consentono l'uso coerente di una struttura multi-campo, i tipi di dati sono più flessibili perché possono essere inclusi ovunque nella struttura dello schema, mentre i mixin possono essere aggiunti solo a livello principale. Per ulteriori informazioni sull'utilizzo dei tipi di dati nell'API, vedere la guida dell'endpoint .

Descrittori

I descrittori sono insiemi 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 possono essere applicate una o più entità descrittore e vi sono diversi tipi di descrittori diversi per scopi diversi. Per ulteriori informazioni sull'utilizzo dei descrittori nell'API, consultate la guida dell'endpoint dei descrittori e una panoramica dei diversi tipi di descrittori e dei relativi casi di utilizzo.

Unioni

La piattaforma consente di comporre gli schemi per casi di utilizzo particolari, ma consente anche di comporre una "unione" di schemi appartenenti a una classe specifica. Uno schema unione aggrega i campi di tutti gli schemi che condividono la stessa classe in un'unica rappresentazione. Abilitando uno schema da utilizzare con Profilo cliente in tempo reale, tale schema viene incluso nell'unione per la classe specifica. Di conseguenza, gli schemi di unione non possono essere modificati direttamente e possono essere modificati solo includendo o escludendo schemi da utilizzare in Profile.

Per informazioni su come visualizzare le unioni nell'API del Registro di sistema dello schema, vedere la guida dell'endpoint delle unioni.

Esporta/Importa

L'API del Registro di sistema dello schema consente di trasferire e condividere risorse XDM tra le sandbox e le organizzazioni IMS. Per qualsiasi schema, mixin o tipo di dati, puoi generare un payload di esportazione contenente la struttura della risorsa e tutte 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 questo endpoint, vedere Riferimento API del Registro di sistema dello schema.

Dati di esempio

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

Per ulteriori informazioni sull'utilizzo di questo endpoint, vedere Riferimento API del Registro di sistema dello schema.

Registro di controllo

Il Registro di sistema dello schema mantiene un registro di tutte le modifiche apportate a una risorsa (classe, mixin, tipo di dati o schema) tra diversi aggiornamenti. È possibile recuperare il registro di una risorsa specifica 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, vedere Riferimento API del Registro di sistema dello schema.

Passaggi successivi

Per iniziare a effettuare chiamate utilizzando l'API del Registro di sistema dello schema, leggi la guida introduttiva, quindi seleziona una delle guide dell'endpoint per apprendere come utilizzare endpoint specifici.

In questa pagina