API centrée sur l'utilisateur

registerUser

POST https://api.pushwoosh.com/json/1.3/registerUser

Associe un identifiant utilisateur externe à un appareil spécifié.

En-têtes de requête

Nom	Requis	Valeur	Description
Authorization	Oui	Token `XXXX`	Jeton d’API d’appareil pour accéder à l’API d’appareil. Remplacez `XXXX` par votre véritable jeton d’API d’appareil.

Corps de la requête

Nom	Type	Description
userId	string	Identifiant utilisateur à associer à un appareil. Si vide, utilise hwid.
application*	string	Code d’application Pushwoosh
hwid*	string	HWID Pushwoosh
tz_offset	integer	Décalage horaire en secondes pour l’appareil.
device_type	integer	Type d’appareil. Voir les valeurs possibles dans `/registerDevice`.

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

Peut être utilisé ultérieurement dans l’appel API /createMessage (le paramètre users).
Il est normal d’appeler cette fonction avant d’avoir le jeton push et avant l’appel /registerDevice.

{
  "request": {
    "userId": "user_3078a",                     // optionnel. Si vide, utilise hwid
    "application": "XXXXX-XXXXX",               // requis. Code d'application Pushwoosh
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // requis. Identifiant matériel de l'appareil
    "tz_offset": -3600,                         // optionnel. Décalage horaire en secondes
    "device_type": 3                            // optionnel. Type d'appareil, voir /registerDevice
                                                //           pour les types d'appareils
  }
}

postEvent

POST https://api.pushwoosh.com/json/1.3/postEvent

Appelle l’événement

En-têtes de requête

Nom	Requis	Valeur	Description
Authorization	Oui	Token `XXXX`	Jeton d’API d’appareil pour accéder à l’API d’appareil. Remplacez `XXXX` par votre véritable jeton d’API d’appareil.

Corps de la requête

Nom	Type	Description
hwid*	string	Identifiant matériel de l’appareil utilisé dans une requête /registerDevice. Peut être utilisé avec ‘userId’ pour identifier un utilisateur qui a déclenché un événement.
application*	string	Code d’application Pushwoosh
event*	string	Nom de l’événement exactement tel que créé dans le panneau de configuration Pushwoosh.
attributes*	object	Objet JSON avec les attributs de l’événement. Laissez vide si aucun attribut ne doit être transmis.
timestampUTC	integer	Horodatage en UTC.
timestampCurrent	integer	Horodatage en heure locale.
userId*	string	Identifiant utilisateur associé à un utilisateur qui a déclenché l’événement. Peut être remplacé par ou utilisé avec un HWID.
device_type	integer	Voir les valeurs possibles

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "code": "61BC9-84DD0"
  }
}

Le nom de l’événement dans la requête doit correspondre au nom de l’événement dans le panneau de configuration Pushwoosh. Notez que la propriété « attributes » peut être vide (mais pas omise) si l’événement n’a pas d’attributs.

{
  "request":{
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // requis. Identifiant matériel de l'appareil utilisé dans une API /registerDevice.
                                                //           Peut être utilisé avec un userId pour identifier un
                                                //           utilisateur qui a déclenché un événement.
    "application": "XXXXX-XXXXX",               // requis. Code d'application Pushwoosh
    "event": "activityCompleted",               // requis. Nom de l'événement exactement tel que créé dans le panneau de configuration Pushwoosh
    "attributes": {                             // requis. Laissez vide si aucun attribut ne doit être transmis.
      "login": "facebook",
      "success": "yes",
      "internet": "wifi",
    },
    "timestampUTC": 1435228403,                 // optionnel. Horodatage en UTC
    "timestampCurrent": 1435253603,             // optionnel. Horodatage en heure locale
    "userId": "someuser@user.com",              // requis. Un identifiant utilisateur utilisé pour l'identification des
                                                //           utilisateurs sur plusieurs appareils. Peut être remplacé par
                                                //           ou utilisé avec un HWID.
    "device_type": 1                            // optionnel.
  }
}