Guida introduttiva all'API Schema Registry

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

Prerequisiti

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

XDM utilizza la formattazione dello schema JSON per descrivere e convalidare la struttura dei dati acquisiti sull’esperienza del cliente. È pertanto consigliabile rivedere la documentazione ufficiale dello schema JSON per comprendere meglio questa tecnologia sottostante.

Lettura delle 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 codice JSON di esempio restituito nelle risposte API. Per informazioni sulle convenzioni utilizzate nella documentazione per le chiamate API di esempio, consulta la sezione su come leggere le chiamate API di esempio nella guida alla risoluzione dei problemi di Experience Platform.

Raccogliere i valori per le intestazioni richieste

Per effettuare chiamate alle API Platform, devi prima completare l'esercitazione di autenticazione. Completando il tutorial sull’autenticazione si ottengono i valori per ciascuna delle intestazioni richieste in tutte le chiamate API di Experience Platform, come mostrato di seguito:

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

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

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

Conoscere il TENANT_ID know-your-tenant_id

Nelle guide API verranno visualizzati i riferimenti a TENANT_ID. Questo ID viene utilizzato per garantire che le risorse create abbiano uno spazio dei nomi corretto e siano contenute all’interno dell’organizzazione. 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: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Risposta

In caso di esito positivo, la risposta restituisce informazioni relative all'utilizzo di Schema Registry da parte dell'organizzazione. Questo include un attributo tenantId, il cui valore è TENANT_ID.

{
  "imsOrg":"{ORG_ID}",
  "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."
      }
    ]
  }
 }

Comprendere CONTAINER_ID container

Le chiamate all'API Schema Registry richiedono l'utilizzo di CONTAINER_ID. È possibile effettuare chiamate API in due contenitori: il contenitore global e il contenitore tenant.

Contenitore globale

Il contenitore global contiene tutti gli Adobi standard e Experience Platform classi, gruppi di campi di schema, tipi di dati e schemi forniti dal partner. È possibile eseguire solo richieste di elenco e ricerca (GET) per il contenitore global.

Un esempio di chiamata che utilizza il contenitore global si presenta come segue:

GET /global/classes

Contenitore tenant

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

Un esempio di chiamata che utilizza il contenitore tenant si presenta come segue:

POST /tenant/fieldgroups

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

Identificazione risorsa resource-identification

Le risorse XDM sono identificate con un attributo $id sotto forma di URI, come negli esempi seguenti:

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

Le chiamate all'API Schema Registry supporteranno l'URI $id con codifica URL o meta:altId (formato con notazione del punto). Si consiglia di utilizzare l'URI $id codificato dall'URL quando si effettua una chiamata REST all'API, come segue:

Accetta intestazione accept

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, è necessario includere anche un numero di versione nell'intestazione Accept.

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

Controllo delle versioni degli schemi versioning

Alle versioni dello schema viene fatto riferimento da Accept intestazioni nell'API Schema Registry e nelle proprietà schemaRef.contentType nei payload API del servizio Platform a valle.

Attualmente, Platform supporta solo una singola versione principale (1) per ogni schema. In base alle regole di evoluzione dello schema, ogni aggiornamento a uno schema deve essere non distruttivo, il che significa che le nuove versioni secondarie di uno schema (1.2, 1.3, ecc.) sono sempre compatibili con le versioni precedenti di versioni secondarie. Pertanto, quando si specifica version=1, il registro dello schema restituisce sempre la ultima versione principale 1 di uno schema, il che significa che le versioni secondarie precedenti non vengono restituite.

Vincoli del campo XDM e best practice

I campi di uno schema sono elencati nel relativo oggetto properties. Ogni campo è di per sé un oggetto, contenente attributi per descrivere e vincolare i dati che il campo può contenere. Per esempi di codice e vincoli facoltativi per i tipi di dati più comunemente utilizzati, consulta la guida su definizione dei campi personalizzati nell'API.

Il seguente campo di esempio illustra un campo XDM formattato correttamente, con ulteriori dettagli sui vincoli di denominazione e le best practice fornite di seguito. Queste procedure 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.",
}

Passaggi successivi

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