Schema Registry Guide des API

Schema Registry est utilisé pour accéder à la bibliothèque de Schémas dans Adobe Experience Platform, fournissant une interface utilisateur et une API RESTful à partir de laquelle toutes les ressources de bibliothèque disponibles sont accessibles.

L’API de registre de Schémas fournit plusieurs points de terminaison qui vous permettent de gérer par programmation tous les schémas et les ressources XDM (Experience Data Model) connexes disponibles dans Platform. Cela inclut les solutions définies par Adobe, Experience Platform partenaires et fournisseurs dont vous utilisez les applications.

Ces points de terminaison sont décrits ci-dessous. Consultez les guides individuels des points de terminaison pour plus de détails et consultez le guide de prise en main pour obtenir des informations importantes sur les en-têtes requis, la lecture d'exemples d'appels d'API, etc.

IMPORTANT

XDM utilise le formatage de Schéma JSON pour décrire et valider la structure des données d’expérience client assimilées. Avant de travailler avec l'API Schéma Registry, il est vivement recommandé de consulter la documentation officielle du Schéma JSON pour mieux comprendre cette technologie sous-jacente.

Pour vue de tous les points de terminaison et opérations CRUD disponibles, consultez la référence de l'API de registre de Schémas.

Schémas

Les schémas XDM représentent et valident la structure et le format des données ingérées dans la plate-forme. Un schéma est composé d’une classe et de zéro, un ou plusieurs mixins. Vous pouvez créer, vue, modifier et supprimer des schémas à l’aide du point de terminaison /schemas. Pour savoir comment utiliser ce point de terminaison, consultez le guide des points de terminaison des schémas.

Pour obtenir un guide détaillé sur la création d'un schéma complet dans l'API de registre des Schémas, y compris la création et l'ajout de mixins et de types de données, consultez le didacticiel sur la création de schémas d'API.

Comportements

Les comportements définissent la nature des données qu’un schéma décrit. Chaque classe XDM doit faire référence à un comportement spécifique, dont tous les schémas qui utilisent cette classe hériteront. Consultez le guide des points de terminaison comportementaux pour savoir comment vue les comportements disponibles dans l'API.

Classes

Une classe définit la structure de base des propriétés communes que tous les schémas basés sur cette classe doivent contenir et détermine quels mixins peuvent être utilisés dans ces schémas. Chaque classe doit être associée à un comportement existant. Pour plus d'informations sur l'utilisation des classes dans l'API, reportez-vous au guide des points de terminaison des classes.

Mixins

Les mixins sont des composants réutilisables qui définissent un ou plusieurs champs qui représentent un concept particulier, tel qu’une personne individuelle, une adresse postale ou un environnement de navigateur Web. Les mixins sont destinés à être inclus dans un schéma qui implémente une classe compatible, en fonction du comportement des données qu'ils représentent (enregistrement ou séries chronologiques). Consultez le guide des points de terminaison des mixins pour savoir comment utiliser les mixins dans l’API.

Types de données

Les types de données sont utilisés comme champs de type référence dans les classes ou les mixins de la même manière que les champs littéraux de base, la différence majeure étant que les types de données peuvent définir plusieurs sous-champs. Bien que semblables aux mixins en ce qu'ils permettent l'utilisation cohérente d'une structure à champs multiples, les types de données sont plus flexibles parce qu'ils peuvent être inclus n'importe où dans la structure de schéma alors que les mixins ne peuvent être ajoutés qu'au niveau racine. Pour plus d'informations sur l'utilisation des types de données dans l'API, consultez le guide des points de terminaison des types de données.

Descripteurs

Descripteurs sont des ensembles de métadonnées affectés à des champs spécifiques au sein d’un schéma, fournissant divers détails contextuels, notamment la manière dont ces champs (et le schéma lui-même) sont liés à d’autres schémas. Chaque schéma peut comporter une ou plusieurs entités descripteurs qui lui sont appliquées et plusieurs types de descripteurs différents peuvent servir à des fins différentes. Pour plus d'informations sur l'utilisation des descripteurs dans l'API, consultez le guide des points de terminaison descripteurs et un aperçu des différents types de descripteurs et de leurs cas d'utilisation.

Unions

Bien que Plateforme vous permette de composer des schémas pour des cas d'utilisation particuliers, elle vous permet également de composer une "union" de schémas appartenant à une classe spécifique. Un schéma d’union agrégat les champs de tous les schémas qui partagent la même classe en une seule représentation. En activant un schéma à utiliser avec Profil client en temps réel, ce schéma est inclus dans l’union pour sa classe particulière. En tant que tel, les schémas d'union ne peuvent pas être modifiés directement et ne peuvent être affectés que par l'inclusion ou l'exclusion de schémas destinés à être utilisés dans le Profil.

Pour savoir comment vue des unions dans l'API de registre des Schémas, consultez le guide des points de terminaison des unions.

Exporter/Importer

L'API Schéma Registry vous permet de transférer et de partager des ressources XDM entre des sandbox et des organisations IMS. Pour tout schéma, mixin ou type de données, vous pouvez générer une charge utile d’exportation contenant la structure de la ressource et les ressources dépendantes. Cette charge utile peut ensuite être utilisée pour importer la ressource dans un sandbox de destination et une organisation IMS.

Pour plus d'informations sur l'utilisation de ces points de terminaison, consultez le guide des points de terminaison export/import.

Sample data

Vous pouvez générer des données d’exemple pour n’importe quel schéma spécifié dans la bibliothèque de Schémas. L'objet de réponse renvoyé peut alors être utilisé comme source d'assimilation de données.

Pour plus d’informations sur l’utilisation de ce point de terminaison, consultez le guide des points de terminaison de données d’exemple.

Journal d’audit

Le registre des Schémas tient un journal de toutes les modifications apportées à une ressource (classe, mixin, type de données ou schéma) entre différentes mises à jour. Vous pouvez récupérer le journal d'une ressource particulière en fournissant ses $id ou meta:altId dans le chemin d'une demande de GET vers ce point de terminaison.

Pour plus d'informations sur l'utilisation de ce point de terminaison, consultez le guide du point de terminaison du journal d'audit.

Étapes suivantes

Pour commencer à lancer des appels à l'aide de l'API Schéma Registry, lisez le guide de prise en main, puis sélectionnez l'un des guides de points de terminaison pour savoir comment utiliser des points de terminaison spécifiques.

Sur cette page

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
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