Getting started with the Schema Registry API

API Schema Registry 允许您创建和管理各种体验数据模型(XDM)资源。 此文档介绍了在尝试调用API之前需要了解的核心概 Schema Registry 念。

先决条件

使用开发人员指南需要对Adobe Experience Platform的以下组件进行有效的了解:

XDM使用JSON模式格式描述和验证所摄取的客户体验数据的结构。 因此,强烈建议您查看官方 JSON模式文档 ,以更好地了解此基础技术。

读取示例API调用

API文 Schema Registry 档提供示例API调用,以演示如何格式化请求。 这包括路径、必需的标头和格式正确的请求负载。 还提供API响应中返回的示例JSON。 有关示例API调用文档中使用的惯例的信息,请参阅Experience Platform疑 难解答指南中有关如何阅读示例API调 用的章节。

收集所需标题的值

要调用API,您必 Platform 须先完成身份验证 教程。 完成身份验证教程可为所有API调用中的每个所需 Experience Platform 标头提供值,如下所示:

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

中的所有资 Experience Platform源(包括属于这些资源 Schema Registry的资源)都隔离到特定虚拟沙箱。 对API的 Platform 所有请求都需要一个标头,它指定操作将在中进行的沙箱的名称:

  • x-sandbox-name: {SANDBOX_NAME}
注意

有关中沙箱的详细信 Platform息,请参阅沙 箱文档

所有对GET的查找() Schema Registry 请求都需 Accept 要一个附加的头,其值决定API返回的信息格式。 有关更多详 细信息 ,请参阅下面的接受标题部分。

所有包含有效负荷(POST、PUT、PATCH)的请求都需要附加标头:

  • Content-Type: application/json

了解您的TENANT_ID

在整个API指南中,您将看到对的引用 TENANT_ID。 此ID用于确保您创建的资源命名正确且包含在IMS组织中。 如果您不知道您的ID,则可以通过执行以下GET请求来访问它:

API格式

GET /stats

请求

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

响应

成功的响应会返回有关您的组织使用的信息 Schema Registry。 这包括一 tenantId 个属性,其值是您的属 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."
      }
    ]
  }
 }

了解 CONTAINER_ID

调用 Schema Registry API需要使用 CONTAINER_ID。 有两种容器可以对其进行API调用:容器 global tenant 和容器。

全球容器

容器 global 包含所有标准Adobe和合作伙伴 Experience Platform 提供的类、混合、数据类型和模式。 您只能对列表执行GET和查找(容器)请 global 求。

使用容器的调用示 global 例如下所示:

GET /global/classes

租户容器

请勿将容器与您的独 TENANT_ID特内容混淆 tenant ,该包含由IMS组织定义的所有类、混合、数据类型、模式和描述符。 这是每个组织特有的,这意味着它们不会被其他IMS组织看到或管理。 您可以对您在容器中创建的资源执行所有CRUD操作(GET、POST、PUT、PATCH、DELETE)。 tenant

使用容器的调用示 tenant 例如下所示:

POST /tenant/mixins

在容器中创建类、混音、模式或数据类 tenant 型时,该类会保存到并为 Schema Registry 其分配 $id 一个包含您的URI TENANT_ID。 它 $id 在整个API中用于引用特定资源。 值的示 $id 例在下一节中提供。

资源标识

XDM资源以URI $id 形式用属性进行标识,如以下示例:

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

为使URI更适合REST,模式还在名为: meta:altId

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

对API Schema Registry 的调用将支持URL编 $id 码的URI meta:altId 或(点记号格式)。 最佳实践是在对API进 $id 行REST调用时使用URL编码的URI,如:

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

接受标题

在API中执行列表和查找( Schema Registry GET)操 Accept 作时,需要一个头来确定API返回的数据的格式。 查找特定资源时,标题中还必须包含版本号 Accept

下表列表了兼容 Accept 的标题值,包括版本号的标题值,以及使用API时返回的内容描述。

接受 描述
application/vnd.adobe.xed-id+json 仅返回列表ID。 这最常用于列出资源。
application/vnd.adobe.xed+json 返回包含原始的完整JSON列表 $ref 模式 allOf 符。 这用于返回一列表完整资源。
application/vnd.adobe.xed+json; version={MAJOR_VERSION} 包含和的 $ref 原始 allOfXDM 有标题和说明。
application/vnd.adobe.xed-full+json; version={MAJOR_VERSION} $ref 属性和已 allOf 解析。 有标题和说明。
application/vnd.adobe.xed-notext+json; version={MAJOR_VERSION} 包含和的 $ref 原始 allOfXDM 无标题或描述。
application/vnd.adobe.xed-full-notext+json; version={MAJOR_VERSION} $ref 属性和已 allOf 解析。 无标题或描述。
application/vnd.adobe.xed-full-desc+json; version={MAJOR_VERSION} $ref 属性和已 allOf 解析。 包含描述符。
注意

如果仅提供主版本(如1、2、3),则注册表将返回最新的次版本(如.1、.2、.3)。

XDM现场限制和最佳实践

模式的字段列在其对象 properties 中。 每个字段本身就是一个对象,包含用于描述和约束字段可包含的数据的属性。

有关在API中定义字段类型的更多信息,请参 阅本指南 的附录,包括代码示例和最常用数据类型的可选约束。

以下示例字段说明了格式正确的XDM字段,其中提供了有关命名约束和最佳实践的更多详细信息。 在定义包含相似属性的其他资源时,也可以应用这些做法。

"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.",
}
  • 字段对象的名称可能包含字母数字、短划线或下划线字符,但 不能以下划线 开始。
    • 正确:fieldName, field_name2, Field-Name field-name_3
    • 不正确: _fieldName
  • 字段对象的名称首选使用camelCase。 示例: fieldName
  • 该字段应包含一个 title以标题大小写写写的字段。 示例: Field Name
  • 该字段需要 type
    • 定义某些类型可能需要可选 format
    • 当需要特定格式化数据时,可 examples 以将其添加为数组。
    • 也可使用注册表中的任何数据类型来定义字段类型。 有关详细信息, 请参阅数据类型端点指南 中有关创建数据类型的一节。
  • 本文 description 介绍了有关现场数据的现场和相关信息。 它应该用完整的句子写成,并有清晰的语言,这样任何访问模式的人都能够理解该领域的意图。

有关如何在 API中定义 不同字段类型的更多信息,请参阅字段约束文档。

后续步骤

要开始使用API进行调 Schema Registry 用,请选择可用的端点指南之一。

在此页面上