GET/PUT Consents / preferences

Obtenir/mettre le consentement utilisateur stocké dans DataCommander

Consents des utilisateurs

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

Ce endpoint vous permet d'obtenir le consentement des catégories pour un utilisateur spécifique

Paramètres de requête

Nom	Type	Description
token	string	Jeton de sécurité
user_id	string	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": "Personne non trouvée"
}

Consents des visiteurs

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

Ce endpoint vous permet d'obtenir le consentement des catégories pour un visiteur spécifique

Paramètres de requête

Nom	Type	Description
callback	string	(optionnel) Callback pour requête jsonp
token	string	Jeton de sécurité
site	entier	ID du site
tc_id	Chaîne	Optionnel. ID de 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": "visiteur non trouvé"
}

User

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

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

Paramètres de requête

Nom	Type	Description
site	string	Id du site (compte)
user_id	string	Id de l'utilisateur. Requis si le paramètre tc_id n'est pas défini
token	string	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 ou 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
  }
}