Introdução à API Schema Registry

A API Schema Registry permite criar e gerenciar vários recursos do Experience Data Model (XDM). Este documento fornece uma introdução aos conceitos principais que você precisa saber antes de tentar fazer chamadas para a API Schema Registry.

Pré-requisitos

O uso do guia do desenvolvedor requer uma compreensão funcional dos seguintes componentes do Adobe Experience Platform:

O XDM usa a formatação do esquema JSON para descrever e validar a estrutura dos dados de experiência do cliente assimilados. Portanto, é altamente recomendável que você consulte a documentação oficial do Esquema JSON para obter uma melhor compreensão dessa tecnologia subjacente.

Leitura de chamadas de API de amostra

A documentação da API Schema Registry fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações. Isso inclui caminhos, cabeçalhos necessários e conteúdos de solicitação formatados corretamente. Também fornece exemplos de JSON retornado nas respostas da API. Para obter informações sobre as convenções usadas na documentação para chamadas de API de exemplo, consulte a seção sobre como ler chamadas de API de exemplo no guia de solução de problemas de Experience Platform.

Coletar valores para cabeçalhos necessários

Para fazer chamadas para APIs do Platform, primeiro complete o tutorial de autenticação. Concluir o tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em todas as chamadas de API da Experience Platform, conforme mostrado abaixo:

Todos os recursos em Experience Platform, incluindo aqueles pertencentes a Schema Registry, estão isolados em sandboxes virtuais específicas. Todas as solicitações para Platform APIs exigem um cabeçalho que especifique o nome da sandbox em que a operação ocorrerá:

Todas as solicitações de pesquisa (GET) para Schema Registry exigem um cabeçalho Accept adicional, cujo valor determina o formato das informações retornadas pela API. Consulte a seção Aceitar cabeçalho abaixo para obter mais detalhes.

Todas as solicitações que contêm um conteúdo (POST, PUT, PATCH) exigem um cabeçalho adicional:

Conhecer seu TENANT_ID know-your-tenant_id

Nos guias de API você verá referências a um TENANT_ID. Essa ID é usada para garantir que os recursos criados tenham o namespace adequado e estejam contidos na organização. Caso não saiba a ID, é possível acessá-la executando a seguinte solicitação do GET:

Formato da API

GET /stats

Solicitação

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

Resposta

Uma resposta bem-sucedida retorna informações sobre o uso do Schema Registry por sua organização. Isso inclui um atributo tenantId, cujo valor é seu 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."
      }
    ]
  }
 }

Entender o CONTAINER_ID container

As chamadas à API Schema Registry exigem o uso de um CONTAINER_ID. Há dois contêineres para os quais as chamadas de API podem ser feitas: o contêiner global e o contêiner tenant.

Contêiner global

O contêiner global contém todas as classes, grupos de campos de esquema, tipos de dados e esquemas fornecidos pelo Adobe padrão e pelo parceiro Experience Platform. Você só pode executar solicitações de lista e pesquisa (GET) no contêiner global.

Um exemplo de uma chamada que usa o contêiner global seria semelhante ao seguinte:

GET /global/classes

Contêiner do inquilino

Para não ser confundido com seu TENANT_ID exclusivo, o contêiner tenant contém todas as classes, grupos de campos, tipos de dados, esquemas e descritores definidos por uma organização. Elas são exclusivas de cada organização, o que significa que não são visíveis nem gerenciáveis por outras organizações. Você pode executar todas as operações CRUD (GET, POST, PUT, PATCH, DELETE) em relação aos recursos criados no contêiner tenant.

Um exemplo de uma chamada que usa o contêiner tenant seria semelhante ao seguinte:

POST /tenant/fieldgroups

Ao criar uma classe, grupo de campos, esquema ou tipo de dados no contêiner tenant, ele é salvo em Schema Registry e é atribuído um URI $id que inclui seu TENANT_ID. Este $id é usado em toda a API para referenciar recursos específicos. Exemplos de valores $id são fornecidos na próxima seção.

Identificação do recurso resource-identification

Os recursos XDM são identificados com um atributo $id no formato de um URI, como os seguintes exemplos:

Para tornar o URI mais amigável, os esquemas também têm uma codificação de notação de pontos do URI em uma propriedade chamada meta:altId:

As chamadas para a API Schema Registry oferecerão suporte ao URI $id codificado em URL ou ao meta:altId (formato de notação de ponto). A prática recomendada é usar o URI $id codificado em URL ao fazer uma chamada REST para a API, da seguinte maneira:

Aceitar cabeçalho accept

Ao executar operações de lista e pesquisa (GET) na API Schema Registry, é necessário um cabeçalho Accept para determinar o formato dos dados retornados pela API. Quando você procura recursos específicos, um número de versão também deve ser incluído no cabeçalho Accept.

A tabela a seguir lista valores de cabeçalho Accept compatíveis, incluindo aqueles com números de versão, juntamente com descrições do que a API retornará quando forem usados.

Controle de versão do esquema versioning

As versões de esquema são referenciadas por Accept cabeçalhos na API do Registro de Esquema e em schemaRef.contentType propriedades nas cargas da API do serviço de plataforma downstream.

Atualmente, a Platform só oferece suporte a uma única versão principal (1) para cada esquema. De acordo com as regras de evolução do esquema, cada atualização de um esquema deve ser não destrutiva, o que significa que novas versões secundárias de um esquema (1.2, 1.3 etc.) são sempre compatíveis com versões anteriores secundárias. Portanto, ao especificar version=1, o Registro de Esquemas sempre retorna a última versão principal 1 de um esquema, o que significa que as versões secundárias anteriores não são retornadas.

Restrições de campo XDM e práticas recomendadas

Os campos de um esquema são listados em seu objeto properties. Cada campo é um objeto que contém atributos para descrever e restringir os dados que o campo pode conter. Consulte o manual sobre definição de campos personalizados na API para obter amostras de código e restrições opcionais para os tipos de dados mais usados.

O campo de amostra a seguir ilustra um campo XDM formatado corretamente, com mais detalhes sobre restrições de nomenclatura e práticas recomendadas fornecidas abaixo. Essas práticas também podem ser aplicadas ao definir outros recursos que contenham atributos semelhantes.

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

Próximas etapas

Para começar a fazer chamadas usando a API Schema Registry, selecione um dos manuais de ponto de extremidade disponíveis.