Guida introduttiva a Schema Registry API

Il Schema Registry API 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 al Schema Registry API.

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, si consiglia vivamente di rivedere Documentazione ufficiale sullo schema JSON per comprendere meglio questa tecnologia di base.

Lettura delle chiamate API di esempio

Il Schema Registry La documentazione API 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 il 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 esempi di chiamate API nella guida alla risoluzione dei problemi di Experience Platform.

Raccogli i valori per le intestazioni richieste

Per effettuare chiamate a Platform , devi prima completare le tutorial sull’autenticazione. Il completamento del tutorial sull’autenticazione fornisce i valori per ciascuna delle intestazioni richieste in tutte Experience Platform Chiamate API, come mostrato di seguito:

Tutte le risorse in Experience Platform, compresi quelli appartenenti al Schema Registry, sono isolate in specifiche sandbox virtuali. Tutte le richieste a Platform Le API richiedono un’intestazione che specifichi il nome della sandbox in cui verrà eseguita l’operazione:

Tutte le richieste di ricerca (GET) a Schema Registry richiede un Accept il cui valore determina il formato delle informazioni restituite dall’API. Consulta la Accetta intestazione per ulteriori dettagli.

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 sono riportati i riferimenti a un 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 da parte della tua organizzazione del Schema Registry. Ciò include tenantId , il cui valore è il tuo 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 la CONTAINER_ID container

Chiamate a Schema Registry Le API richiedono l’utilizzo di un CONTAINER_ID. Esistono due contenitori in cui è possibile effettuare chiamate API: global contenitore e tenant contenitore.

Contenitore globale

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

Esempio di chiamata che utilizza global il contenitore avrà un aspetto simile al seguente:

GET /global/classes

Contenitore tenant

Da non confondere con il tuo unico TENANT_ID, il tenant contenitore 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. Puoi eseguire tutte le operazioni CRUD (GET, POST, PUT, PATCH, DELETE) sulle risorse create in tenant contenitore.

Esempio di chiamata che utilizza tenant il contenitore avrà un aspetto simile al seguente:

POST /tenant/fieldgroups

Quando crei una classe, un gruppo di campi, uno schema o un tipo di dati nel tenant contenitore, viene salvato nel Schema Registry e ha assegnato un $id URI che include TENANT_ID. Questo $id viene utilizzato in tutta l’API per fare riferimento a risorse specifiche. Esempi di $id I valori vengono forniti nella sezione successiva.

Identificazione risorsa resource-identification

Le risorse XDM sono identificate con un $id un attributo nella forma di un URI, ad esempio:

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:

Chiamate a Schema Registry L’API supporterà sia il formato con codifica URL $id URI o meta:altId (formato di notazione con punto). Si consiglia di utilizzare il codice URL $id URI quando si effettua una chiamata REST all’API, come segue:

Accetta intestazione accept

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

Nella tabella seguente sono elencate le opzioni compatibili Accept i valori di intestazione, inclusi quelli con i numeri di versione, insieme alle descrizioni di ciò che l’API restituirà quando vengono utilizzati.

Controllo delle versioni degli schemi versioning

Esistono riferimenti alle versioni degli schemi da Accept intestazioni nell’API Schema Registry e in schemaRef.contentType proprietà nei payload API del servizio Platform a valle.

Attualmente, Platform supporta solo una singola versione principale (1) per ogni schema. In base al 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 più recente 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 nei relativi properties oggetto. Ogni campo è di per sé un oggetto, contenente attributi per descrivere e vincolare i dati che il campo può contenere. Consulta la guida su definizione dei campi personalizzati nell’API per 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 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 Schema Registry API, seleziona una delle guide endpoint disponibili.