Schema Registry Guía de API

El Schema Registry se utiliza para acceder a la biblioteca de esquemas en Adobe Experience Platform, proporcionando una interfaz de usuario y una API RESTful desde la cual se puede acceder a todos los recursos de biblioteca disponibles.

La API del Registro de esquemas proporciona varios extremos que le permiten administrar mediante programación todos los esquemas y recursos relacionados del Modelo de datos de experiencias (XDM) disponibles para usted en Platform. Esto incluye los definidos por Adobe, Experience Platform socios y proveedores cuyas aplicaciones utiliza.

Estos extremos se describen a continuación. Visite las guías de puntos finales individuales para obtener más información y consulte la guía de introducción para obtener información importante sobre los encabezados necesarios, leer llamadas de API de ejemplo y más.

IMPORTANTE

XDM utiliza el formato de esquema JSON para describir y validar la estructura de los datos de experiencia del cliente incorporados. Antes de trabajar con la API del Registro de esquemas, se recomienda que revise la documentación oficial del Esquema JSON para comprender mejor esta tecnología subyacente.

Para ver todos los extremos disponibles y las operaciones de CRUD, visite la referencia de la API del Registro de Esquemas.

Esquemas

Los esquemas XDM representan y validan la estructura y el formato de los datos introducidos en Platform. Un esquema está compuesto por una clase y cero o más grupos de campos de esquema. Puede crear, ver, editar y eliminar esquemas con el extremo /schemas . Para aprender a utilizar este punto final, consulte la guía de extremo de esquemas.

Para obtener una guía paso a paso sobre cómo crear un esquema completo en la API del Registro de esquemas, incluida la creación y adición de grupos de campos y tipos de datos, consulte el tutorial de creación de esquemas de API.

Comportamientos

Los comportamientos definen la naturaleza de los datos que describe un esquema. Cada clase XDM debe hacer referencia a un comportamiento específico, que heredarán todos los esquemas que emplean esa clase. Consulte la guía de extremo de comportamientos para obtener información sobre cómo ver los comportamientos disponibles en la API.

Clases

Una clase define la estructura base de las propiedades comunes que deben contener todos los esquemas basados en esa clase y determina qué grupos de campos son aptos para su uso en esos esquemas. Cada clase debe estar asociada a un comportamiento existente. Consulte la guía de extremo de clases para obtener más información sobre cómo trabajar con clases en la API.

Grupos de campo

Los grupos de campos son componentes reutilizables que definen uno o más campos que representan un concepto en particular, como una persona individual, una dirección de correo o un entorno de explorador web. Los grupos de campos están pensados para incluirse como parte de un esquema que implemente una clase compatible, según el comportamiento de los datos que representan (registro o serie temporal). Consulte la guía de extremo de grupos de campos para aprender a trabajar con grupos de campos en la API.

Tipos de datos

Los tipos de datos se utilizan como campos de tipo de referencia en clases o grupos de campos de la misma manera que los campos literales básicos; la diferencia clave es que los tipos de datos pueden definir varios subcampos. Aunque son similares a los grupos de campos en que permiten el uso coherente de una estructura de varios campos, los tipos de datos son más flexibles porque se pueden incluir en cualquier parte de la estructura del esquema, mientras que los grupos de campos solo se pueden agregar en el nivel raíz. Consulte la guía de extremo de tipos de datos para obtener más información sobre cómo trabajar con tipos de datos en la API.

Descriptores

Los descriptores son conjuntos de metadatos que se asignan a campos específicos dentro de un esquema y proporcionan varios detalles contextuales, incluido cómo esos campos (y el propio esquema) están relacionados con otros esquemas. Cada esquema puede tener una o más entidades descriptivas aplicadas a él, y hay varios tipos de descriptor diferentes para servir a diferentes propósitos. Consulte la guía de extremo de descriptores para obtener más información sobre cómo trabajar con descriptores en la API y una descripción general de los distintos tipos de descriptor y sus casos de uso.

Uniones

Aunque Platform le permite componer esquemas para casos de uso particulares, también le permite componer una "unión" de esquemas pertenecientes a una clase específica. Un esquema de unión agrega los campos de todos los esquemas que comparten la misma clase en una sola representación. Al habilitar un esquema para su uso con Perfil del cliente en tiempo real, ese esquema se incluye en la unión para su clase particular. De este modo, los esquemas de unión no se pueden editar directamente y solo se pueden ver afectados si se incluyen o excluyen los esquemas para su uso en Perfil.

Para obtener información sobre cómo ver uniones en la API del Registro de esquemas, consulte la guía de extremo de uniones.

Exportar/Importar

La API del Registro de esquemas permite transferir y compartir recursos XDM entre entornos limitados y organizaciones de IMS. Para cualquier esquema, grupo de campos o tipo de datos, puede generar una carga útil de exportación que contenga la estructura del recurso y cualquier recurso dependiente. Esta carga útil se puede utilizar para importar el recurso en un entorno limitado de destino y en una organización de IMS.

Consulte la guía de puntos finales de exportación/importación para obtener más información sobre cómo utilizar estos puntos finales.

Datos de muestra

Puede generar datos de ejemplo para cualquier esquema especificado en la Biblioteca de esquemas. El objeto Response devuelto se puede utilizar como fuente de consumo de datos.

Consulte la guía de extremo de datos de ejemplo para obtener más información sobre el uso de este extremo.

Registro de auditoría

El Registro de esquemas mantiene un registro de todos los cambios que se han producido en un recurso (clase, grupo de campos, tipo de datos o esquema) entre diferentes actualizaciones. Puede recuperar el registro de un recurso en particular proporcionando su $id o meta:altId en la ruta de una solicitud de GET a este extremo.

Consulte la guía de extremo del registro de auditoría para obtener más información sobre el uso de este extremo.

Pasos siguientes

Para empezar a realizar llamadas mediante la API del Registro de esquemas, lea la guía de introducción y, a continuación, seleccione una de las guías de puntos finales para aprender a utilizar puntos finales específicos.

En esta página

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