Show Menu
TÓPICOS×

Fundamentos da API do Adobe Experience Platform

As APIs da plataforma Adobe Experience utilizam várias tecnologias e sintaxes subjacentes que são importantes de entender para gerenciar eficientemente os recursos da plataforma baseados em JSON. Este documento fornece uma breve visão geral dessas tecnologias, além de links para a documentação externa para obter mais informações.

Ponteiro JSON

JSON Pointer é uma sintaxe de sequência padronizada ( RFC 6901 ) para identificar valores específicos em documentos JSON. Um ponteiro JSON é uma string de tokens separados por / caracteres, que especifica chaves de objeto ou índices de matriz, e os tokens podem ser uma string ou um número. As strings de ponteiro JSON são usadas em muitas operações PATCH para APIs de plataforma, conforme descrito posteriormente neste documento. Para obter mais informações sobre o ponteiro JSON, consulte a documentação de visão geral do ponteiro JSON.

Exemplo de objeto de schema 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"
        }
    }
}

Exemplo de ponteiros JSON com base no objeto schema

Ponteiro JSON
Resolve para
"/title"
"Detalhes do Membro de Fidelidade"
"/definitions/loyalty"
(Retorna o conteúdo do loyalty objeto)
"/definitions/loyalty/properties/_{TENANT_ID}/properties/loyaltyLevel/enum"
["platinum", "gold", "silver", "bronze"]
"/definitions/loyalty/properties/_{TENANT_ID}/properties/loyaltyLevel/enum/0"
"platinum"

Patch JSON

Há muitas operações PATCH para APIs de plataforma que aceitam objetos Patch JSON para suas cargas de solicitação. O Patch JSON é um formato padronizado ( RFC 6902 ) para descrever alterações em um documento JSON. Ele permite que você defina atualizações parciais para JSON sem precisar enviar o documento inteiro em um corpo de solicitação.

Exemplo de objeto de correção JSON

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

  • op : O tipo de operação de patch. Embora o Patch JSON suporte vários tipos de operação diferentes, nem todas as operações PATCH nas APIs de plataforma são compatíveis com cada tipo de operação. Os tipos de operação disponíveis são:
    • add
    • remove
    • replace
    • copy
    • move
    • test
  • path : A parte da estrutura JSON a ser atualizada, identificada usando a notação JSON Pointer .
Dependendo do tipo de operação indicado em op , o objeto JSON Patch pode exigir propriedades adicionais. Para obter mais informações sobre as diferentes operações de Patch JSON e sua sintaxe necessária, consulte a documentação do Patch JSON.

Schema JSON

O Schema JSON é um formato usado para descrever e validar a estrutura dos dados JSON. O Experience Data Model (XDM) aproveita os recursos do Schema JSON para impor restrições na estrutura e formato dos dados de experiência do cliente assimilados. Para obter mais informações sobre o Schema JSON, consulte a documentação oficial.

Próximas etapas

Este documento apresentou algumas das tecnologias e sintaxes envolvidas com o gerenciamento de recursos baseados em JSON para a plataforma Experience. Para obter mais informações sobre como trabalhar com APIs de plataforma, incluindo práticas recomendadas e respostas a perguntas frequentes, consulte o guia de solução de problemas da plataforma.