Utilisateurs API

Visiteur

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

Cet endpoint vous permet de

obtenir les propriétés d'un visiteur spécifique

. Lorsque vous créez le token, vous pouvez définir quelles propriétés retourner.

\

Cette API est davantage conçue pour être appelée depuis un tag dans le navigateur de chaque utilisateur.

Paramètres de requête

Nom	Type	Description
callback	string	(optionnel) Callback pour une requête jsonp
token	string	Security token
site	integer	ID du site
tcid	string	Cookie id. Si vide (recommandé) il lira le tcid dans le cookie de l'utilisateur.

200

{
    "user_age": 39,
    "user_privacy_categories": [
      "11",
      "12",
      "13"
    ]
}

Utilisateur

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

Cet endpoint vous permet de

obtenir les propriétés d'un utilisateur spécifique

basé sur un

user_id

. Lorsque vous créez le token, vous pouvez définir quelles propriétés retourner.

Paramètres de requête

Nom	Type	Description
token	string	Security token
user_id	string	ID de l'utilisateur
site	integer	ID du site

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

{
    "user_age": 39,
    "user_privacy_categories": [
      "11",
      "12",
      "13"
    ]
}

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

{
    "message": "Personne non trouvée"
}

Utilisateur

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

Insérer ou mettre à jour un utilisateur

Paramètres de requête

Nom	Type	Description
site	string	Id du site (compte)
user_id	string	Id de l'utilisateur.
token	string	Security token

200

{"success":true}

Exemple de requête

PUT

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

{
"preferences.channel":"email",
"preference.frequency":"30d",
...
}

DELETE user

Supprimer un utilisateur

URL de la ressource

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

Informations sur la ressource

Formats de réponse	JSON
Nécessite une authentification ?	Oui (token)

Paramètres

NOM	EXIGENCE	VALEURS D'EXEMPLE	DESCRIPTION
site	d+	1234	Id du site
user_id	d+	1234	Id de l'utilisateur
tc_id (optionnel)	d+	1234	Id du visiteur
token	[a-zA-Z0-9]*	WvNIX8955cnZ7WF0f632s0Wb99Ql3rtA	Security token

Exemple de requête

DELETE

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

Réponse

{"success":true}