User-centric API

registerUser

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

Связывает внешний User ID с указанным устройством.

Заголовки запроса

Имя	Обязательно	Значение	Описание
Authorization	Да	Token `XXXX`	API Device Token для доступа к Device API. Замените `XXXX` на ваш реальный токен Device API.

Тело запроса

Имя	Тип	Описание
userId	string	User ID для привязки к устройству. Если пусто, используется hwid.
application*	string	Pushwoosh application code
hwid*	string	Pushwoosh HWID
tz_offset	integer	Смещение часового пояса устройства в секундах.
device_type	integer	Тип устройства. См. возможные значения в `/registerDevice`.

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

Может быть использован позже в вызове API /createMessage (параметр users).
Вызов этой функции до получения push-токена и до вызова /registerDevice является стандартной практикой.

{
  "request": {
    "userId": "user_3078a",                     // optional. If empty, use hwid
    "application": "XXXXX-XXXXX",               // required. Pushwoosh application code
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // required. Hardware device ID
    "tz_offset": -3600,                         // optional. Timezone offset in seconds
    "device_type": 3                            // optional. Device type, see /registerDevice
                                                //           for device types
  }
}

postEvent

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

Отправляет событие.

Заголовки запроса

Имя	Обязательно	Значение	Описание
Authorization	Да	Token `XXXX`	API Device Token для доступа к Device API. Замените `XXXX` на ваш реальный токен Device API.

Тело запроса

Имя	Тип	Описание
hwid*	string	Hardware device ID, используемый в запросе /registerDevice. Может использоваться вместе с ‘userId’ для идентификации пользователя, вызвавшего событие.
application*	string	Pushwoosh application code
event*	string	Имя события в точности так, как оно создано в Pushwoosh Control Panel.
attributes*	object	JSON-объект с атрибутами события. Оставьте пустым, если атрибуты передавать не нужно.
timestampUTC	integer	Временная метка в UTC.
timestampCurrent	integer	Временная метка в локальном времени.
userId*	string	User ID, связанный с пользователем, вызвавшим событие. Может быть заменен или использован вместе с HWID.
device_type	integer	См. возможные значения

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

Имя события в запросе должно совпадать с именем события в Pushwoosh Control Panel. Обратите внимание, что свойство “attributes” может быть пустым (но не отсутствовать), если у события нет атрибутов.

{
  "request":{
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // required. Hardware device ID used in a /registerDevice API.
                                                //           Can be used along with an userId to identify a
                                                //           user who has triggered an event.
    "application": "XXXXX-XXXXX",               // required. Pushwoosh application code
    "event": "activityCompleted",               // required. Event name exactly as created in Pushwoosh Control Panel
    "attributes": {                             // required. Leave empty if no attributes need to be passed.
      "login": "facebook",
      "success": "yes",
      "internet": "wifi",
    },
    "timestampUTC": 1435228403,                 // optional. Timestamp in UTC
    "timestampCurrent": 1435253603,             // optional. Timestamp in local time
    "userId": "someuser@user.com",              // required. A user id which is used for identification of
                                                //           users on multiple devices. Can be replaced by
                                                //           or used along with an HWID.
    "device_type": 1                            // optional.
  }
}