Configurer les attributs utilisateur

Adresse d'invocation

POST /v1/user/property

Vérification de l'invocation

L'API REST EngageLab utilise l'authentification HTTP Basic comme méthode de vérification. Ajoutez Authorization dans l'en-tête HTTP :

              
              Authorization: Basic ${base64_auth_string}

            

Le base64_auth_string est généré selon l'algorithme suivant : base64(api_key:api_secret).

• Le nom de l'en-tête est "Authorization", et la valeur est la paire "nom d'utilisateur:mot de passe" encodée en base64 (séparée par deux-points).
• Pour l'API MA, le nom d'utilisateur correspond à l'APIKey, et le mot de passe correspond à l'APISecret. Veuillez configurer une source de données de type API pour obtenir l'APIKey et l'APISecret.

Exemple de requête

En-tête de la requête

              
              > POST /v1/user/property
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

            

Corps de la requête

              
              {
    "euid": 10362473,
    "type": "set",
    "properties": {
        "user_number_once": 46.2,
        "user_string_once": "refef",
        "user_datetime_once": "2023-12-12 00:56:23"
    }
}

            

Paramètres de la requête

Types d’opération

Toutes les propriétés d’une requête utilisent le même type. Les valeurs prises en charge sont set, increase, add, remove, delete, setOnce et update.

Opérations sur les tableaux d’objets

Pour object_array, la valeur de add est un objet JSON unique et celle de set est un tableau d’objets JSON. remove et update localisent un élément avec $identifier_key et $identifier_value ; le champ identifiant doit être un sous-champ string ou number défini.

La valeur de remove ne peut contenir que ces deux champs identifiants :

              
              {
  "euid": 10362473,
  "type": "remove",
  "properties": {
    "devices": {
      "$identifier_key": "device_id",
      "$identifier_value": "ios-001"
    }
  }
}

            

update doit également inclure un $new_object non vide. Il ne peut pas contenir le champ identifiant ; les champs dont la valeur est null sont supprimés de l’élément trouvé. L’identifiant doit correspondre à exactement un élément du tableau.

              
              {
  "euid": 10362473,
  "type": "update",
  "properties": {
    "devices": {
      "$identifier_key": "device_id",
      "$identifier_value": "ios-001",
      "$new_object": {
        "model": "iPhone 16",
        "legacy_field": null
      }
    }
  }
}

            

Paramètres de retour

Tout réussi

              
              {
    "code": 0,
    "message": "success"
}

            

Tout échoué

              
              {
    "code": 55102,
    "message": "Invalid user attributes exist"
}

            

Codes d'erreur