Show Menu
TEMAS×

Conceptos básicos de la API de Adobe Experience Platform

Las API de Adobe Experience Platform emplean varias tecnologías subyacentes y sintaxis que son importantes de comprender para administrar eficazmente los recursos basados en Platform JSON. Este documento ofrece una breve descripción general de estas tecnologías, así como enlaces a documentación externa para obtener más información.

Puntero JSON

JSON Pointer 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 especifica 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, como se describe más adelante en este documento. Para obtener más información sobre JSON Pointer, consulte la documentación general de JSON Pointer.

Ejemplo de objeto de esquema JSON

{
    "type": "object",
    "title": "Loyalty Member Details",
    "meta:intendedToExtend": [
        "https://ns.adobe.com/xdm/context/profile"
    ],
    "description": "Loyalty Program Mixin.",
    "definitions": {
        "loyalty": {
            "properties": {
                "_{TENANT_ID}": {
                    "type": "object",
                    "properties": {
                        "loyaltyId": {
                            "title": "Loyalty Identifier",
                            "type": "string",
                            "description": "Loyalty Identifier.",
                            "meta:xdmType": "string"
                        },
                        "loyaltyLevel": {
                            "title": "Loyalty Level",
                            "description": "The current loyalty program level to which the individual member belongs.",
                            "type": "string",
                            "enum": [
                                "platinum",
                                "gold",
                                "silver",
                                "bronze"
                            ],
                            "meta:enum": {
                                "platinum": "Platinum",
                                "gold": "Gold",
                                "silver": "Silver",
                                "bronze": "Bronze"
                            },
                            "meta:xdmType": "string"
                        }
                    },
                    "meta:xdmType": "object"
                }
            },
            "type": "object",
            "meta:xdmType": "object"
        }
    }
}

Ejemplo de punteros JSON basados en el objeto esquema

Puntero JSON
Resuelve en
"/title"
"Detalles de miembros de lealtad"
"/definitions/loyalty"
(Devuelve el contenido del loyalty objeto)
"/definitions/loyalty/properties/_{TENANT_ID}/properties/loyaltyLevel/enum"
["platinum", "gold", "silver", "bronze"]
"/definitions/loyalty/properties/_{TENANT_ID}/properties/loyaltyLevel/enum/0"
"platinum"
Al tratar con los xdm:sourceProperty atributos y xdm:destinationProperty de los descriptores Experience Data Model (XDM), cualquier properties clave debe ser excluida de la cadena de puntero JSON. Para obtener más información, consulte la guía para desarrolladores de Schema Registry API en la subguía de descriptores .

Parche JSON

Hay muchas operaciones de PATCH para Platform API que aceptan objetos JSON Patch para sus cargas de solicitud. JSON Patch es un formato estandarizado ( RFC 6902 ) para describir los cambios en un documento JSON. Le permite definir actualizaciones parciales a JSON sin necesidad de enviar el documento completo en un cuerpo de solicitud.

Ejemplo de objeto JSON Patch

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

  • op :: Tipo de operación de parche. Aunque JSON Patch admite varios tipos de operaciones diferentes, no todas las operaciones de PATCH en Platform las API son compatibles con cada tipo de operación. Los tipos de operaciones disponibles son:
    • add
    • remove
    • replace
    • copy
    • move
    • test
  • path :: Parte de la estructura JSON que se va a actualizar e identificar usando notación de puntero JSON .
Según el tipo de operación indicado en op , el objeto JSON Patch puede requerir propiedades adicionales. Para obtener más información sobre las distintas operaciones de parche JSON y su sintaxis requerida, consulte la documentación de parche JSON.

Esquema JSON

Esquema JSON es un formato que se utiliza para describir y validar la estructura de los datos JSON. El modelo de datos de experiencia (XDM) aprovecha las capacidades de Esquema JSON para imponer restricciones en la estructura y el formato de los datos de experiencia del cliente ingestados. 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 relacionadas con la administración de recursos basados en JSON para Experience Platform. Para obtener más información sobre el trabajo con Platform las API, incluidas las prácticas recomendadas y las respuestas a las preguntas más frecuentes, consulte la guía de solución de problemas de la plataforma .