GET/PUT consentements / préférences

Récupérer/mettre à jour le consentement utilisateur stocké dans DataCommander

Consentements des utilisateurs

GET https://api.commander1.com/engage/user/

Cet endpoint vous permet d'obtenir le consentement par catégorie pour un utilisateur spécifique

Paramètres de requête

Nom	Type	Description
token	chaîne	Jeton de sécurité
user_id	chaîne	ID de l'utilisateur
site	entier	ID du site

200 Consentement récupéré avec succès.

{
    "user_privacy_optin": 1,
    "user_privacy_categories": [
      "11",
      "12",
      "13"
    ]
}

404 Impossible de trouver un utilisateur correspondant à cette requête.

{
    "message": "Person not found"
}

Consentements des visiteurs

GET https://api.commander1.com/v1.0/engage/visitors/

Cet endpoint vous permet d'obtenir le consentement par catégorie pour un visiteur spécifique

Paramètres de requête

Nom	Type	Description
callback	chaîne	(facultatif) callback pour une requête jsonp
token	chaîne	Jeton de sécurité
site	entier	ID du site
tc_id	Chaîne	Facultatif. ID cookie de l'utilisateur

200 Exemple avec réponse optin

{
    "user_privacy_optin": 1,
    "user_privacy_categories": [
      "11",
      "12",
      "13"
    ]
}

202 Exemple avec réponse optout

{
    "user_privacy_optin": 0,
    "user_privacy_categories": []
}

404

{
    "message": "visitor not found"
}

Préférences utilisateur

PUT https://api.commander1.com/engage/user/

Insérer ou mettre à jour une préférence dans la base de données (nécessite d'avoir le module DataCommander activé)

Paramètres de requête

Nom	Type	Description
site	chaîne	ID du site (compte)
user_id	chaîne	ID de l'utilisateur. Requis si le paramètre tc_id n'est pas défini
token	chaîne	Jeton de sécurité

200

{"success":true}

Syntaxe et limitations

• Le payload json est représenté par une paire clé/valeur pour chaque préférence.

• Chaque propriété de préférence (clé) commence par "preferences." suivie du nom de la préférence : preferences.your_preference_name

• Le nom de la préférence ne doit pas contenir d'espace, de point ni de caractères spéciaux. Son format est [A-Za-z0-9_-]

• La valeur de la préférence peut contenir des espaces, des points, mais pas de caractères spéciaux.

• L'API accepte un maximum de 20 préférences

Exemple de requête

PUT

https://api.commander1.com/engage/user/?site=1234&user_id=1234&token=WvNIX8955cnZ7WF0f632s0Wb99Ql3rtA

{
  "preferences": {
    "news_monthly": true,
    "news_sales": true
  }
}