Fundamentos de API de Experience Platform

Las API de Adobe Experience Platform emplean varias tecnologías y sintaxis subyacentes que son importantes de comprender para administrar de forma eficaz las API basadas en JSON Platform recursos. Este documento proporciona una breve descripción general de estas tecnologías, así como vínculos a documentación externa para obtener más información.

Puntero JSON json-pointer

El puntero JSON es una sintaxis de cadena estandarizada (RFC 6901) para identificar valores específicos dentro de documentos JSON. Un puntero JSON es una cadena de tokens separados por / caracteres, que especifican claves de objeto o índices de matriz, y los tokens pueden ser una cadena o un número. Las cadenas de puntero JSON se utilizan en muchas operaciones de PATCH para Platform API, tal como se describe más adelante en este documento. Para obtener más información sobre el puntero JSON, consulte la Documentación de información general del puntero JSON.

Ejemplo de objeto de esquema JSON

El siguiente JSON representa un esquema XDM simplificado cuyos campos pueden referenciarse mediante cadenas de puntero JSON. Tenga en cuenta que todos los campos que se han agregado mediante grupos de campos de esquema personalizados (como loyaltyLevel) tienen un espacio de nombres en _{TENANT_ID} , mientras que los campos que se han añadido mediante grupos de campos principales (como fullName) no son.

{
  "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/85a4bdaa168b01bf44384e049fbd3d2e9b2ffaca440d35b9",
  "meta:altId": "_{TENANT_ID}.schemas.85a4bdaa168b01bf44384e049fbd3d2e9b2ffaca440d35b9",
  "meta:resourceType": "schemas",
  "version": "1.0",
  "title": "Example schema",
  "type": "object",
  "description": "This is an example schema.",
  "properties": {
    "_{TENANT_ID}": {
      "type": "object",
      "properties": {
        "loyaltyLevel": {
          "title": "Loyalty Level",
          "description": "",
          "type": "string",
          "isRequired": false,
          "enum": [
            "platinum",
            "gold",
            "silver",
            "bronze"
          ]
        }
      }
    },
    "person": {
      "title": "Person",
      "description": "An individual actor, contact, or owner.",
      "type": "object",
      "properties": {
        "name": {
          "title": "Full name",
          "description": "The person's full name.",
          "type": "object",
          "properties": {
            "fullName": {
              "title": "Full name",
              "type": "string",
              "description": "The full name of the person, in writing order most commonly accepted in the language of the name.",
            },
            "suffix": {
              "title": "Suffix",
              "type": "string",
              "description": "A group of letters provided after a person's name to provide additional information. The `suffix` is used at the end of someones name. For example Jr., Sr., M.D., PhD, I, II, III, etc.",
            }
          },
          "meta:referencedFrom": "https://ns.adobe.com/xdm/context/person-name",
          "meta:xdmField": "xdm:name"
        }
      }
    }
  }
}

Ejemplo de punteros JSON basados en el objeto de esquema

Parche de JSON json-patch

Hay muchas operaciones de PATCH para Platform API que aceptan objetos de parche JSON para sus cargas útiles de solicitud. El parche JSON tiene un formato estandarizado (RFC 6902) para describir cambios en un documento JSON. Permite definir actualizaciones parciales de JSON sin necesidad de enviar todo el documento en un cuerpo de solicitud.

Ejemplo de objeto de parche de JSON

{
  "op": "remove",
  "path": "/foo"
}

Dependiendo del tipo de operación indicado en op, el objeto Parche de JSON puede requerir propiedades adicionales. Para obtener más información sobre las distintas operaciones de parches de JSON y su sintaxis requerida, consulte la Documentación de parches de JSON.

Esquema JSON json-schema

El esquema JSON es un formato que se utiliza para describir y validar la estructura de los datos JSON. Modelo de datos de experiencia (XDM) aprovecha las capacidades del esquema JSON para aplicar restricciones en la estructura y el formato de los datos de experiencia del cliente introducidos. Para obtener más información sobre el esquema JSON, consulte la documentación oficial.

Pasos siguientes

Este documento introdujo algunas de las tecnologías y sintaxis involucradas con la administración de recursos basados en JSON para Experience Platform. Consulte la guía de introducción para obtener más información sobre cómo trabajar con las API de Platform, incluidas las prácticas recomendadas. Para obtener respuestas a las preguntas más frecuentes, consulte la Guía de solución de problemas de Platform.