Guida introduttiva all'API Schema Registry

L'API Schema Registry consente di creare e gestire diverse risorse Experience Data Model (XDM). Questo documento fornisce un'introduzione ai concetti di base da conoscere prima di tentare di effettuare chiamate all'API Schema Registry.

Prerequisiti

L’utilizzo della guida per gli sviluppatori richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:

  • Experience Data Model (XDM) System: Il framework standard con cui Experience Platform organizzare i dati relativi all'esperienza dei clienti.
  • Real-time Customer Profile: Fornisce un profilo di consumo unificato e in tempo reale basato su dati aggregati provenienti da più origini.
  • Sandboxes: Experience Platform fornisce sandbox virtuali che dividono una singola Platform istanza in ambienti virtuali separati per sviluppare e sviluppare applicazioni per esperienze digitali.

XDM utilizza la formattazione dello schema JSON per descrivere e convalidare la struttura dei dati esperienza cliente acquisiti. Si consiglia pertanto vivamente di consultare la documentazione ufficiale dello schema JSON per una migliore comprensione di questa tecnologia sottostante.

Lettura di chiamate API di esempio

La documentazione API Schema Registry fornisce esempi di chiamate API per dimostrare come formattare le richieste. Questi includono percorsi, intestazioni richieste e payload di richieste formattati correttamente. Viene inoltre fornito un JSON di esempio restituito nelle risposte API. Per informazioni sulle convenzioni utilizzate nella documentazione per le chiamate API di esempio, consultate la sezione relativa a come leggere chiamate API di esempio nella guida alla risoluzione dei problemi del Experience Platform .

Raccogli valori per le intestazioni richieste

Per effettuare chiamate alle Platform API, è innanzitutto necessario completare l'esercitazione sull'autenticazione a2/>. Completando l'esercitazione sull'autenticazione, vengono forniti i valori per ciascuna delle intestazioni richieste in tutte le chiamate API Experience Platform, come illustrato di seguito:

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

Tutte le risorse in Experience Platform, incluse quelle appartenenti a Schema Registry, sono isolate in sandbox virtuali specifiche. Tutte le richieste alle Platform API richiedono un'intestazione che specifica il nome della sandbox in cui verrà eseguita l'operazione:

  • x-sandbox-name: {SANDBOX_NAME}
NOTA

Per ulteriori informazioni sulle sandbox in Platform, consultate la documentazione sandbox.

Tutte le richieste di ricerca (GET) al Schema Registry richiedono un'intestazione Accept aggiuntiva, il cui valore determina il formato delle informazioni restituite dall'API. Per ulteriori informazioni, vedere la sezione Accetta intestazione di seguito.

Tutte le richieste che contengono un payload (POST, PUT, PATCH) richiedono un'intestazione aggiuntiva:

  • Content-Type: application/json

Conoscere il tuo TENANT_ID

Nelle guide API verranno visualizzati i riferimenti a un TENANT_ID. Questo ID viene utilizzato per garantire che le risorse create siano correttamente denominate e contenute all’interno dell’organizzazione IMS. Se non conosci il tuo ID, puoi accedervi eseguendo la seguente richiesta di GET:

Formato API

GET /stats

Richiesta

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}'

Risposta

Una risposta corretta restituisce informazioni relative all'utilizzo da parte dell'organizzazione di Schema Registry. Questo include un attributo tenantId, il cui valore è il TENANT_ID.

{
  "imsOrg":"{IMS_ORG}",
  "tenantId":"{TENANT_ID}",
  "counts": {
    "schemas": 4,
    "mixins": 3,
    "datatypes": 1,
    "classes": 2,
    "unions": 0,
  },
  "recentlyCreatedResources": [ 
    {
      "title": "Sample Mixin",
      "description": "New Sample Mixin.",
      "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 Mixin",
      "description": "New Sample Mixin.",
      "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."
      }
    ]
  }
 }

Comprendere CONTAINER_ID

Le chiamate all'API Schema Registry richiedono l'utilizzo di un CONTAINER_ID. Esistono due contenitori in base ai quali è possibile effettuare chiamate API: il contenitore global e il contenitore tenant.

Contenitore globale

Il contenitore global contiene tutte le classi, i mixin, i tipi di dati e gli schemi standard e Experience Platform forniti dal partner. È possibile eseguire solo richieste di elenco e di ricerca (GET) per il contenitore global.

Un esempio di chiamata che utilizza il contenitore global sarà simile al seguente:

GET /global/classes

Contenitore tenant

Da non confondere con il TENANT_ID univoco, il contenitore tenant contiene tutte le classi, i mixin, i tipi di dati, gli schemi e i descrittori definiti da un'organizzazione IMS. Queste sono esclusive per ogni organizzazione, il che significa che non sono visibili o gestibili da altre organizzazioni IMS. È possibile eseguire tutte le operazioni CRUD (GET, POST, PUT, PATCH, DELETE) rispetto alle risorse create nel contenitore tenant.

Un esempio di chiamata che utilizza il contenitore tenant sarà simile al seguente:

POST /tenant/mixins

Quando si crea una classe, un mixin, uno schema o un tipo di dati nel contenitore tenant, questo viene salvato nel contenitore Schema Registry e gli viene assegnato un URI $id che include il TENANT_ID. Questo $id viene utilizzato in tutta l'API per fare riferimento a risorse specifiche. Esempi di valori $id sono forniti nella sezione successiva.

Identificazione risorsa

Le risorse XDM sono identificate con un attributo $id sotto forma di URI, ad esempio i seguenti esempi:

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

Per rendere l’URI più semplice, gli schemi dispongono anche di una codifica con notazione punto dell’URI in una proprietà denominata meta:altId:

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

Le chiamate all'API Schema Registry supporteranno l'URI con codifica URL $id o il formato di notazione del punto meta:altId. È consigliabile utilizzare l'URI con codifica URL $id quando si esegue una chiamata REST all'API, come segue:

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

Accetta intestazione

Quando si eseguono operazioni di elenco e ricerca (GET) nell'API Schema Registry, è necessaria un'intestazione Accept per determinare il formato dei dati restituiti dall'API. Quando si cercano risorse specifiche, nell'intestazione Accept deve essere incluso anche un numero di versione.

Nella tabella seguente sono elencati i valori di intestazione Accept compatibili, inclusi quelli con numeri di versione, insieme alle descrizioni di ciò che l'API restituirà quando verrà utilizzata.

Accetta Descrizione
application/vnd.adobe.xed-id+json Restituisce solo un elenco di ID. Viene utilizzato più comunemente per elencare le risorse.
application/vnd.adobe.xed+json Restituisce un elenco dello schema JSON completo con $ref originale e allOf inclusi. Viene utilizzato per restituire un elenco completo delle risorse.
application/vnd.adobe.xed+json; version={MAJOR_VERSION} XDM raw con $ref e allOf. Contiene titoli e descrizioni.
application/vnd.adobe.xed-full+json; version={MAJOR_VERSION} $ref e allOf risolto. Contiene titoli e descrizioni.
application/vnd.adobe.xed-notext+json; version={MAJOR_VERSION} XDM raw con $ref e allOf. Nessun titolo o descrizione.
application/vnd.adobe.xed-full-notext+json; version={MAJOR_VERSION} $ref e allOf risolto. Nessun titolo o descrizione.
application/vnd.adobe.xed-full-desc+json; version={MAJOR_VERSION} $ref e allOf risolto. I descrittori sono inclusi.
NOTA

Se si fornisce solo la versione principale (ad esempio 1, 2, 3), il registro restituirà la versione minore più recente (ad esempio .1, .2, .3) automaticamente.

Vincoli del campo XDM e procedure ottimali

I campi di uno schema sono elencati all'interno del relativo oggetto properties. Ciascun campo è esso stesso un oggetto contenente attributi per descrivere e vincolare i dati che il campo può contenere.

Ulteriori informazioni sulla definizione dei tipi di campo nell'API sono disponibili nell' appendice di questa guida, inclusi esempi di codice e vincoli facoltativi per i tipi di dati più comunemente utilizzati.

Il seguente campo di esempio illustra un campo XDM formattato correttamente, con ulteriori dettagli sui vincoli di denominazione e sulle procedure ottimali riportati di seguito. Queste pratiche possono essere applicate anche quando si definiscono altre risorse che contengono attributi simili.

"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.",
}
  • Il nome di un oggetto campo può contenere caratteri alfanumerici, trattini o caratteri di sottolineatura, ma non può iniziare con un carattere di sottolineatura.
    • Corretto: fieldName, field_name2, Field-Name, field-name_3
    • Scorretto: _fieldName
  • camelCase è preferibile per il nome dell'oggetto field. Esempio: fieldName
  • Il campo deve includere un title, scritto in Case titolo. Esempio: Field Name
  • Il campo richiede un valore type.
    • La definizione di alcuni tipi può richiedere un format facoltativo.
    • Se è necessaria una formattazione specifica dei dati, è possibile aggiungere examples come array.
    • Il tipo di campo può essere definito anche utilizzando qualsiasi tipo di dati presente nel registro. Per ulteriori informazioni, vedere la sezione relativa alla creazione di un tipo di dati nella guida dell'endpoint dei tipi di dati.
  • La sezione description spiega il campo e le informazioni pertinenti relative ai dati del campo. Dovrebbe essere scritto in frasi complete con un linguaggio chiaro in modo che chiunque acceda allo schema possa capire le intenzioni del campo.

Per ulteriori informazioni sulla definizione di diversi tipi di campi nell'API, consultare il documento relativo alle limitazioni dei campi.

Passaggi successivi

Per iniziare a effettuare chiamate utilizzando l'API Schema Registry, seleziona una delle guide endpoint disponibili.

In questa pagina