API centrée sur l'utilisateur

registerUser

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

Associe un User ID externe à un appareil spécifié.

En-têtes de la requête

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

Corps de la requête

Nom	Type	Description
userId	string	User ID à associer à un appareil. S’il est vide, utilisez hwid.
application*	string	Code d’application Pushwoosh
hwid*	string	HWID Pushwoosh
tz_offset	integer	Décalage du fuseau 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 token push et avant l’appel /registerDevice.

{
  "request": {
    "userId": "user_3078a",                     // optionnel. Si vide, utilisez hwid
    "application": "XXXXX-XXXXX",               // requis. Code d'application Pushwoosh
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // requis. ID matériel de l'appareil (Hardware device ID)
    "tz_offset": -3600,                         // optionnel. Décalage du fuseau 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

Déclenche l’événement

En-têtes de la requête

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

Corps de la requête

Nom	Type	Description
hwid*	string	ID matériel de l’appareil (Hardware device ID) 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 tel qu’il a été créé dans le Control Panel de Pushwoosh.
attributes*	object	Objet JSON avec les attributs de l’événement. Laissez-le vide si aucun attribut ne doit être transmis.
timestampUTC	integer	Horodatage en UTC.
timestampCurrent	integer	Horodatage en heure locale.
userId*	string	User ID 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 dans la méthode /registerDevice.

{
  "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 Control Panel de 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. ID matériel de l'appareil (Hardware device ID) 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 tel qu'il a été créé dans le Control Panel de 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 User ID qui est utilisé pour l'identification
                                                //           des utilisateurs sur plusieurs appareils. Peut être remplacé par
                                                //           ou utilisé avec un HWID.
    "device_type": 1                            // optionnel.
  }
}