Show Menu
SUJETS×

Concepts fondamentaux de l’API Adobe Experience Platform

Les API Adobe Experience Platform utilisent plusieurs technologies et syntaxes sous-jacentes qui sont importantes à comprendre pour gérer efficacement les ressources de plateformes JSON. Ce document présente un bref aperçu de ces technologies, ainsi que des liens vers la documentation externe pour plus d'informations.

Pointeur JSON

JSON Pointer est une syntaxe de chaîne standard ( RFC 6901 ) permettant d’identifier des valeurs spécifiques dans les documents JSON. Un pointeur JSON est une chaîne de jetons séparés par / des caractères qui spécifient des clés d’objet ou des index de tableau, et les jetons peuvent être une chaîne ou un nombre. Les chaînes de pointeur JSON sont utilisées dans de nombreuses opérations PATCH pour les API de plateformes, comme décrit plus loin dans ce document. Pour plus d’informations sur le pointeur JSON, reportez-vous à la documentation d’aperçu du pointeur JSON.

Exemple d’objet de schéma 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"
        }
    }
}

Exemple de pointeurs JSON basés sur un objet schéma

Pointeur JSON
Résout à
"/title"
"Détails du membre de fidélité"
"/definitions/loyalty"
(Renvoie le contenu de l’ loyalty objet)
"/definitions/loyalty/properties/_{TENANT_ID}/properties/loyaltyLevel/enum"
["platinum", "gold", "silver", "bronze"]
"/definitions/loyalty/properties/_{TENANT_ID}/properties/loyaltyLevel/enum/0"
"platinum"

Correctif JSON

Il existe de nombreuses opérations PATCH pour les API de plateforme qui acceptent les objets de correctif JSON pour leurs charges utiles de demande. Le correctif JSON est un format normalisé ( RFC 6902 ) qui décrit les modifications apportées à un document JSON. Il vous permet de définir des mises à jour partielles de JSON sans avoir à envoyer l’ensemble du document dans un corps de requête.

Exemple d’objet Patch JSON

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

  • op : Type d'opération de correctif. Bien que le correctif JSON prenne en charge plusieurs types d’opérations différents, toutes les opérations PATCH dans les API de plateformes ne sont pas compatibles avec chaque type d’opération. Les types d'opération disponibles sont les suivants :
    • add
    • remove
    • replace
    • copy
    • move
    • test
  • path : Partie de la structure JSON à mettre à jour, identifiée à l’aide de la notation Pointeur Pointeur JSON JSON.
Selon le type d’opération indiqué dans op , l’objet Patch JSON peut nécessiter des propriétés supplémentaires. Pour plus d’informations sur les différentes opérations de correctif JSON et leur syntaxe requise, consultez la documentation sur le correctif JSON.

Schéma JSON

Le Schéma JSON est un format utilisé pour décrire et valider la structure des données JSON. Le modèle de données d’expérience (XDM) utilise les capacités de Schéma JSON pour imposer des contraintes sur la structure et le format des données d’expérience client imbriquées. Pour plus d'informations sur le Schéma JSON, veuillez consulter la documentation officielle.

Étapes suivantes

Ce document présente certaines des technologies et syntaxes impliquées dans la gestion des ressources JSON pour Experience Platform. Pour plus d’informations sur l’utilisation des API de plateforme, y compris les meilleures pratiques et les réponses aux questions fréquentes, consultez le guide de dépannage de plateforme.