Erste Schritte mit der Schema Registry-API

Mit der API Schema Registry können Sie verschiedene XDM-Ressourcen (Experience-Datenmodell) erstellen und verwalten. In diesem Dokument erhalten Sie eine Einführung in die wichtigsten Konzepte, die Sie kennen sollten, bevor Sie Aufrufe an die Schema Registry-API durchführen.

Voraussetzungen

Die Verwendung des Entwicklerhandbuchs setzt ein Verständnis der folgenden Komponenten von Adobe Experience Platform voraus:

  • Experience Data Model (XDM) System: Das standardisierte Framework, mit dem Experience Platform Kundenerlebnisdaten organisiert.
  • Real-time Customer Profile: Bietet ein einheitliches Echtzeit-Kundenprofil, das auf aggregierten Daten aus verschiedenen Quellen basiert.
  • Sandboxes: Experience Platform bietet virtuelle Sandboxes, die eine einzelne Platform-Instanz in separate virtuelle Umgebungen unterteilen, damit Sie Programme für digitale Erlebnisse entwickeln und weiterentwickeln können.

XDM verwendet die JSON-Schema-Formatierung, um die Struktur der erfassten Kundenerlebnisdaten zu beschreiben und zu validieren. Es wird daher dringend empfohlen, die offizielle JSON-Schema-Dokumentation zu lesen, um ein besseres Verständnis dieser zugrunde liegenden Technologie zu erhalten.

Lesen von Beispiel-API-Aufrufen

In der Dokumentation der Schema Registry-API wird anhand von Beispielen für API-Aufrufe die korrekte Formatierung von Anfragen aufgezeigt. Dazu gehören Pfade, erforderliche Kopfzeilen und ordnungsgemäß formatierte Anfrage-Payloads. Außerdem wird ein Beispiel für eine von der API im JSON-Format zurückgegebene Antwort bereitgestellt. Informationen zu den Konventionen, die in der Dokumentation für Beispiel-API-Aufrufe verwendet werden, finden Sie im Abschnitt zum Lesen von Beispiel-API-Aufrufen im Handbuch zur Fehlerbehebung für Experience Platform.

Sammeln von Werten für erforderliche Kopfzeilen

Um Platform-APIs aufzurufen, müssen Sie zunächst das Authentifizierungs-Tutorial abschließen. Durch Abschluss des Authentifizierungs-Tutorials werden die Werte für die einzelnen erforderlichen Header in allen Experience Platform-API-Aufrufen bereitgestellt, wie unten dargestellt:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Alle Ressourcen in Experience Platform, einschließlich der Ressourcen, die zu Schema Registry gehören, werden auf bestimmte virtuelle Sandboxes beschränkt. Bei allen Anfragen an Platform-APIs ist eine Kopfzeile erforderlich, die den Namen der Sandbox angibt, in der der Vorgang ausgeführt werden soll:

  • x-sandbox-name: {SANDBOX_NAME}
HINWEIS

Weitere Informationen zu Sandboxes in Platform finden Sie in der Sandbox-Dokumentation.

Für alle Nachschlageanfragen (GET) an Schema Registry ist eine zusätzliche Accept-Kopfzeile erforderlich, deren Wert das Format der von der API zurückgegebenen Informationen bestimmt. Weitere Informationen finden Sie unten im Abschnitt Accept-Kopfzeile.

Bei allen Anfragen mit einer Payload (POST, PUT, PATCH) ist eine zusätzliche Kopfzeile erforderlich:

  • Content-Type: application/json

Ihre TENANT_ID

In den API-Handbüchern finden Sie Verweise auf TENANT_ID. Diese Kennung stellt sicher, dass die von Ihnen erstellten Ressourcen den richtigen Namespace aufweisen und in Ihrer IMS-Organisation enthalten sind. Wenn Sie Ihre ID nicht kennen, können Sie sie mit der folgenden GET-Anfrage abrufen:

API-Format

GET /stats

Anfrage

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/stats \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwort

Eine erfolgreiche Antwort gibt Informationen zur Verwendung von Schema Registry durch Ihr Unternehmen zurück. Dies beinhaltet ein tenantId-Attribut, dessen Wert Ihre TENANT_ID ist.

{
  "imsOrg":"{IMS_ORG}",
  "tenantId":"{TENANT_ID}",
  "counts": {
    "schemas": 4,
    "mixins": 3,
    "datatypes": 1,
    "classes": 2,
    "unions": 0,
  },
  "recentlyCreatedResources": [ 
    {
      "title": "Sample Field Group",
      "description": "New Sample Field Group.",
      "meta:resourceType": "mixins",
      "meta:created": "Sat Feb 02 2019 00:24:30 GMT+0000 (UTC)",
      "version": "1.1"
    },
    {
      "$id": "https://ns.adobe.com/{TENANT_ID}/classes/5bdb5582be0c0f3ebfc1c603b705764f",
      "title": "Tenant Class",
      "description": "Tenant Defined Class",
      "meta:resourceType": "classes",
      "meta:created": "Fri Feb 01 2019 22:46:21 GMT+0000 (UTC)",
      "version": "1.0"
    } 
  ],
  "recentlyUpdatedResources": [
    {
      "title": "Sample Field Group",
      "description": "New Sample Field Group.",
      "meta:resourceType": "mixins",
      "meta:updated": "Sat Feb 02 2019 00:34:06 GMT+0000 (UTC)",
      "version": "1.1"
    },
    {
      "title": "Data Schema",
      "description": "Schema for Data Information",
      "meta:resourceType": "schemas",
      "meta:updated": "Fri Feb 01 2019 23:47:43 GMT+0000 (UTC)",
      "meta:class": "https://ns.adobe.com/{TENANT_ID}/classes/47b2189fc135e03c844b4f25139d10ab",
      "meta:classTitle": "Sample Class",
      "version": "1.1"
    }
 ],
 "classUsage": {
    "https://ns.adobe.com/{TENANT_ID}/classes/47b2189fc135e03c844b4f25139d10ab": [
      {
        "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/274f17bc5807ff307a046bab1489fb18",
        "title": "Tenant Data Schema",
        "description": "Schema for tenant-specific data."
      }
    ],
    "https://ns.adobe.com/xdm/context/profile": [
      {
        "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/3ac6499f0a43618bba6b138226ae3542",
        "title": "Simple Profile",
        "description": "A simple profile schema."
      },
      {
        "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/fbc52b243d04b5d4f41eaa72a8ba58be",
        "title": "Program Schema",
        "description": "Schema for program-related data."
      },
      {
        "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/4025a705890c6d4a4a06b16f8cf6f4ca",
        "title": "Sample Schema",
        "description": "A sample schema."
      }
    ]
  }
 }

Die CONTAINER_ID

Aufrufe der API Schema Registry erfordern die Verwendung eines CONTAINER_ID. Es gibt zwei Container, für die API-Aufrufe durchgeführt werden können: den global-Container und den tenant-Container.

Globaler Container

Der global-Container enthält alle Standardklassen und vom Experience Platform Partner bereitgestellten Adoben, Schemafeldgruppen, Datentypen und Schemata. Sie dürfen nur Listen- und Suchanfragen (GET) für den global-Container ausführen.

Ein Beispiel für einen Aufruf, der den global -Container verwendet, würde wie folgt aussehen:

GET /global/classes

Mandanten-Container

Der tenant-Container ist nicht mit Ihrem eindeutigen TENANT_ID zu verwechseln. Er enthält alle Klassen, Feldergruppen, Datentypen, Schemata und Deskriptoren, die von einer IMS-Organisation definiert wurden. Sie sind für jede Organisation eindeutig, d h. sie sind für andere IMS-Organisationen nicht sichtbar oder verwaltbar. Sie können alle CRUD-Vorgänge (GET, POST, PUT, PATCH, DELETE) für Ressourcen ausführen, die Sie im tenant-Container erstellen.

Ein Beispiel für einen Aufruf, der den tenant -Container verwendet, würde wie folgt aussehen:

POST /tenant/fieldgroups

Wenn Sie eine Klasse, Feldergruppe, ein Schema oder einen Datentyp im tenant-Container erstellen, wird dieser in Schema Registry gespeichert und ein $id -URI zugewiesen, der Ihre TENANT_ID enthält. Diese $id wird in der gesamten API verwendet, um auf bestimmte Ressourcen zu verweisen. Beispiele für Werte der $id finden Sie im nächsten Abschnitt.

Resource identification

XDM-Ressourcen werden mit einem $id -Attribut in Form eines URI identifiziert, z. B. in den folgenden Beispielen:

  • https://ns.adobe.com/xdm/context/profile
  • https://ns.adobe.com/{TENANT_ID}/schemas/7442343-abs2343-21232421

Um den URI REST-freundlicher zu gestalten, verfügen Schemata auch über eine Punktnotationskodierung des URI in einer Eigenschaft mit der Bezeichnung meta:altId:

  • _xdm.context.profile
  • _{TENANT_ID}.schemas.7442343-abs2343-21232421

Aufrufe der API Schema Registry unterstützen entweder den URL-kodierten $id-URI oder den meta:altId-URI (Punktnotationsformat). Es empfiehlt sich, den URL-kodierten $id-URI zu verwenden, wenn Sie einen REST-Aufruf an die API ausführen, wie z. B.:

  • https%3A%2F%2Fns.adobe.com%2Fxdm%2Fcontext%2Fprofile
  • https%3A%2F%2Fns.adobe.com%2F{TENANT_ID}%2Fschemas%2F7442343-abs2343-21232421

Accept-Kopfzeile

Bei der Ausführung von Listen- und Lookup-Vorgängen (GET) in der API Schema Registry ist eine Accept-Kopfzeile erforderlich, um das Format der von der API zurückgegebenen Daten zu bestimmen. Bei der Suche nach bestimmten Ressourcen muss auch eine Versionsnummer in die Accept-Kopfzeile aufgenommen werden.

In der folgenden Tabelle sind kompatible Accept-Kopfzeilenwerte aufgeführt, einschließlich solcher mit Versionsnummern, sowie Beschreibungen dessen, was die API zurückgibt, wenn sie verwendet werden.

Accept Beschreibung
application/vnd.adobe.xed-id+json Gibt nur eine Liste von IDs zurück. Dies wird am häufigsten für die Auflistung von Ressourcen verwendet.
application/vnd.adobe.xed+json Gibt eine Liste des vollständigen JSON-Schemata einschließlich der ursprünglichen $ref und allOf zurück. Damit wird eine Liste der vollständigen Ressourcen zurückgegeben.
application/vnd.adobe.xed+json; version=1 Raw-XDM mit $ref und allOf. Beinhaltet Titel und Beschreibungen.
application/vnd.adobe.xed-full+json; version=1 $ref-Attribute und allOf aufgelöst. Beinhaltet Titel und Beschreibungen.
application/vnd.adobe.xed-notext+json; version=1 Raw-XDM mit $ref und allOf. Keine Titel oder Beschreibungen.
application/vnd.adobe.xed-full-notext+json; version=1 $ref-Attribute und allOf aufgelöst. Keine Titel oder Beschreibungen.
application/vnd.adobe.xed-full-desc+json; version=1 $ref-Attribute und allOf aufgelöst. Deskriptoren sind enthalten.
HINWEIS

Platform unterstützt derzeit nur eine Hauptversion für jedes Schema (1). Daher muss der Wert für version bei Suchanfragen immer 1 sein, um die neueste Nebenversion des Schemas zurückzugeben. Weitere Informationen zur Schemaversionierung finden Sie im Unterabschnitt unten.

Schemaversionierung

Schemaversionen werden von Accept -Kopfzeilen in der Schema Registry-API und in den schemaRef.contentType -Eigenschaften in nachgelagerten Platform-Dienst-API-Payloads referenziert.

Derzeit unterstützt Platform nur eine einzelne Hauptversion (1) für jedes Schema. Gemäß den Regeln der Schemaentwicklung muss jede Schemaaktualisierung zerstörungsfrei sein, d. h. neue Nebenversionen eines Schemas (1.2, 1.3 usw.) sind immer abwärtskompatibel mit früheren Nebenversionen. Daher gibt die Schema Registry bei der Angabe von version=1 immer die neueste Hauptversion 1 eines Schemas zurück, d. h. vorherige Nebenversionen werden nicht zurückgegeben.

HINWEIS

Die zerstörungsfreie Anforderung für die Schemaentwicklung wird erst erzwungen, nachdem das Schema von einem Datensatz referenziert wurde und einer der folgenden Fälle wahr ist:

  • Daten wurden in den Datensatz aufgenommen.
  • Der Datensatz wurde für die Verwendung im Echtzeit-Kundenprofil aktiviert (auch wenn keine Daten erfasst wurden).

Wenn das Schema keinem Datensatz zugeordnet wurde, der eines der oben genannten Kriterien erfüllt, kann es geändert werden. In allen Fällen bleibt die Komponente version jedoch weiterhin bei 1.

XDM-Feldbeschränkungen und Best Practices

Die Felder eines Schemas werden innerhalb seines properties-Objekts aufgelistet. Jedes Feld ist selbst ein Objekt, das Attribute zur Beschreibung und Beschränkung der Daten enthält, die das Feld enthalten kann.

Weitere Informationen zum Definieren von Feldtypen in der API finden Sie im Handbuch zu Feldbeschränkungen für dieses Handbuch, einschließlich Codebeispielen und optionalen Einschränkungen für die am häufigsten verwendeten Datentypen.

Das folgende Beispielfeld veranschaulicht ein korrekt formatiertes XDM-Feld, wobei weitere Einzelheiten zu den Benennungsbeschränkungen und Best Practices weiter unten aufgeführt sind. Diese Verfahren können auch bei der Definition anderer Ressourcen angewendet werden, die ähnliche Attribute enthalten.

"fieldName": {
    "title": "Field Name",
    "type": "string",
    "format": "date-time",
    "examples": [
        "2004-10-23T12:00:00-06:00"
    ],
    "description": "Full sentence describing the field, using proper grammar and punctuation.",
}
  • Der Name eines Feldobjekts kann alphanumerische Zeichen, Bindestriche oder Unterstriche enthalten, darf jedoch nicht mit einem Unterstrich beginnen.
    • Richtig: fieldName, field_name2, Field-Name, field-name_3
    • Falsch: _fieldName
  • Die CamelCase-Notation (gemischte Groß-/Kleinschreibung) wird für den Namen des Feldobjekts bevorzugt. Beispiel: fieldName
  • Das Feld sollte einen title in Titelschrift-Notation (erster Buchstabe groß) enthalten. Beispiel: Field Name
  • Für das Feld ist ein type erforderlich.
    • Die Definition bestimmter Typen erfordert möglicherweise ein optionales format.
    • Wenn eine bestimmte Formatierung der Daten erforderlich ist, kann examples als Array hinzugefügt werden.
    • Der Feldtyp kann auch mit einem beliebigen Datentyp in der Registry definiert werden. Weitere Informationen finden Sie im Abschnitt zum Erstellen eines Datentyps🔗 im Endpunkthandbuch zu Datentypen .
  • In description wird das Feld und relevante Informationen zu den Felddaten erklärt. Dies sollte in vollständigen Sätzen mit klarer Sprache geschrieben sein, damit jeder, der auf das Schema zugreift, die Absicht des Feldes verstehen kann.

Weitere Informationen zum Definieren verschiedener Feldtypen in der API finden Sie im Dokument zu Feldbeschränkungen .

Nächste Schritte

Um mit dem Aufrufen der Schema Registry-API zu beginnen, wählen Sie eines der verfügbaren Handbücher zu Endpunkten.

Auf dieser Seite