Schema Registry API 시작하기

Schema Registry API를 사용하면 다양한 XDM(Experience Data Model) 리소스를 만들고 관리할 수 있습니다. 이 문서에서는 Schema Registry API를 호출하기 전에 알아야 하는 핵심 개념을 소개합니다.

전제 조건

개발자 안내서를 사용하려면 Adobe Experience Platform의 다음 구성 요소를 이해하고 있어야 합니다.

  • Experience Data Model (XDM) System:고객 경험 데이터를 Experience Platform 구성하는 표준화된 프레임워크입니다.
  • Real-time Customer Profile:여러 소스에서 집계된 데이터를 기반으로 통합된 실시간 소비자 프로필을 제공합니다.
  • Sandboxes: Experience Platform 에서는 디지털 경험 애플리케이션을 개발하고 발전시키는 데 도움이 Platform 되는 단일 인스턴스를 별도의 가상 환경으로 분할하는 가상 샌드박스를 제공합니다.

XDM은 JSON 스키마 형식을 사용하여 수집된 고객 경험 데이터의 구조를 설명하고 확인합니다. 따라서 이 기본 기술을 더 잘 이해하려면 공식 JSON 스키마 설명서를 검토하는 것이 좋습니다.

샘플 API 호출 읽기

Schema Registry API 설명서는 요청의 형식을 지정하는 방법을 보여주는 예제 API 호출을 제공합니다. 여기에는 경로, 필수 헤더 및 올바른 형식의 요청 페이로드가 포함됩니다. API 응답으로 반환되는 샘플 JSON도 제공됩니다. 샘플 API 호출에 대한 설명서에 사용된 규칙에 대한 자세한 내용은 Experience Platform 문제 해결 안내서에서 예제 API 호출를 읽는 방법 섹션을 참조하십시오.

필수 헤더에 대한 값을 수집합니다

Platform API를 호출하려면 먼저 인증 자습서를 완료해야 합니다. 인증 자습서를 완료하면 아래와 같이 모든 Experience Platform API 호출에 필요한 각 헤더에 대한 값을 제공합니다.

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

Schema Registry에 속하는 리소스를 포함하여 Experience Platform의 모든 리소스는 특정 가상 샌드박스로 구분됩니다. Platform API에 대한 모든 요청에는 작업이 수행될 샌드박스의 이름을 지정하는 헤더가 필요합니다.

  • x-sandbox-name: {SANDBOX_NAME}
노트

Platform의 샌드박스에 대한 자세한 내용은 샌드박스 설명서를 참조하십시오.

Schema Registry에 대한 모든 조회(GET) 요청에는 API에서 반환되는 정보의 형식을 결정하는 추가 Accept 헤더가 필요합니다. 자세한 내용은 아래의 헤더 섹션을 참조하십시오.

페이로드(POST, PUT, PATCH)이 포함된 모든 요청에는 추가 헤더가 필요합니다.

  • Content-Type: application/json

TENANT_ID 알기

API 가이드 전체에서 TENANT_ID에 대한 참조가 표시됩니다. 이 ID는 사용자가 만드는 리소스가 제대로 식별되고 IMS 조직 내에 포함되어 있는지 확인하는 데 사용됩니다. ID를 모를 경우 다음 GET 요청을 수행하여 ID에 액세스할 수 있습니다.

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 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."
      }
    ]
  }
 }

CONTAINER_ID 이해

Schema Registry API를 호출하려면 CONTAINER_ID을 사용해야 합니다. API 호출을 수행할 수 있는 컨테이너는 두 가지가 있습니다.global 컨테이너 및 tenant 컨테이너.

전역 컨테이너

global 컨테이너에는 모든 표준 Adobe 및 Experience Platform 파트너가 제공하는 클래스, 스키마 필드 그룹, 데이터 유형 및 스키마가 있습니다. global 컨테이너에 대해서만 목록 및 조회(GET) 요청만 수행할 수 있습니다.

global 컨테이너를 사용하는 호출의 예는 다음과 같습니다.

GET /global/classes

테넌트 컨테이너

고유한 TENANT_ID 과 혼동하지 않도록 tenant 컨테이너에는 IMS 조직에서 정의한 모든 클래스, 필드 그룹, 데이터 유형, 스키마 및 설명자가 들어 있습니다. 이러한 기능은 각 조직에 고유하며 다른 IMS 조직에서 보거나 관리할 수 없습니다. tenant 컨테이너에서 만든 리소스에 대해 모든 CRUD 작업(GET, POST, PUT, PATCH, DELETE)을 수행할 수 있습니다.

tenant 컨테이너를 사용하는 호출의 예는 다음과 같습니다.

POST /tenant/fieldgroups

tenant 컨테이너에 클래스, 필드 그룹, 스키마 또는 데이터 유형을 만들면 Schema Registry에 저장되고 TENANT_ID를 포함하는 $id URI가 할당됩니다. 이 $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 속성에 URI의 점 표기법 인코딩이 있습니다.

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

Schema Registry API를 호출하면 URL로 인코딩된 $id URI 또는 meta:altId(점 표기법 형식)가 지원됩니다. 우수 사례는 다음과 같이 API에 REST 호출을 수행할 때 URL 인코딩된 $id URI를 사용하는 것입니다.

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

Accept header

Schema Registry API에서 목록 및 조회(GET) 작업을 수행할 때 API에서 반환되는 데이터의 형식을 결정하려면 Accept 헤더가 필요합니다. 특정 리소스를 찾을 때 버전 번호도 Accept 헤더에 포함해야 합니다.

다음 표에는 버전 번호가 있는 헤더 값을 포함하여 호환되는 Accept 헤더 값이 나열되며, 헤더 값이 사용될 때 API가 반환할 내용에 대한 설명이 나와 있습니다.

Accept 설명
application/vnd.adobe.xed-id+json ID 목록만 반환합니다. 리소스 목록은 가장 일반적으로 사용됩니다.
application/vnd.adobe.xed+json 원래 $refallOf이 포함된 전체 JSON 스키마 목록을 반환합니다. 전체 리소스 목록을 반환하는 데 사용됩니다.
application/vnd.adobe.xed+json; version=1 $refallOf 가 있는 원시 XDM. 제목과 설명이 있습니다.
application/vnd.adobe.xed-full+json; version=1 $ref 특성과 allOf 해결됨. 제목과 설명이 있습니다.
application/vnd.adobe.xed-notext+json; version=1 $refallOf 가 있는 원시 XDM. 제목 또는 설명이 없습니다.
application/vnd.adobe.xed-full-notext+json; version=1 $ref 특성과 allOf 해결됨. 제목 또는 설명이 없습니다.
application/vnd.adobe.xed-full-desc+json; version=1 $ref 특성과 allOf 해결됨. 설명자가 포함되어 있습니다.
노트

플랫폼은 현재 각 스키마에 대해 하나의 주 버전만 지원합니다(1). 따라서 스키마의 최신 부 버전을 반환하려면 조회 요청을 수행할 때 version 값은 항상 1이어야 합니다. 스키마 버전 관리에 대한 자세한 내용은 아래 하위 섹션을 참조하십시오.

스키마 버전 관리

스키마 버전은 스키마 레지스트리 API의 Accept 헤더와 다운스트림 Platform 서비스 API 페이로드의 schemaRef.contentType 속성에서 참조됩니다.

현재 Platform은 각 스키마에 대해 단일 주요 버전(1)만 지원합니다. 스키마 진화 규칙에 따르면 스키마에 대한 각 업데이트는 비파괴적이어야 합니다. 즉, 새로운 부 버전의 스키마(1.2, 1.3 등)는 이전 부 버전과 항상 이전 버전과 호환됩니다. 따라서 version=1을 지정할 때 스키마 레지스트리에서 항상 스키마의 최신 주 버전 1을 반환합니다. 즉, 이전 부 버전은 반환되지 않습니다.

노트

스키마 진화에 대한 비파괴 요구 사항은 데이터 세트에 의해 스키마가 참조되고 다음 중 하나가 참인 후에만 적용됩니다.

  • 데이터를 데이터 집합에 수집했습니다.
  • 데이터 세트가 실시간 고객 프로필에서 사용할 수 있도록 활성화되었습니다(데이터가 수집되지 않은 경우에도).

스키마가 위의 기준 중 하나를 충족하는 데이터 세트와 연결되어 있지 않으면 변경할 수 있습니다. 그러나 모든 경우 version 구성 요소는 여전히 1에 남아 있습니다.

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
  • field 개체의 이름은 camelCase가 선호됩니다. 예: fieldName
  • 필드에는 제목 사례에 작성된 title이 포함되어야 합니다. 예: Field Name
  • 필드에 type이 필요합니다.
    • 특정 유형을 정의하려면 선택 사항인 format이 필요할 수 있습니다.
    • 데이터의 특정 포맷이 필요한 경우 examples을 배열로 추가할 수 있습니다.
    • 레지스트리에서 데이터 유형을 사용하여 필드 유형을 정의할 수도 있습니다. 자세한 내용은 데이터 유형 엔드포인트 안내서의 데이터 유형 만들기에 대한 섹션을 참조하십시오.
  • description 에서는 필드 데이터와 관련된 필드 및 관련 정보를 설명합니다. 스키마에 액세스하는 모든 사람이 필드의 의도를 이해할 수 있도록 명확한 언어로 전체 문장을 작성해야 합니다.

API에서 다른 필드 유형을 정의하는 방법에 대한 자세한 내용은 필드 제한의 문서를 참조하십시오.

다음 단계

Schema Registry API를 사용하여 호출을 시작하려면 사용 가능한 엔드포인트 가이드 중 하나를 선택합니다.

이 페이지에서는