API, ориентированный на пользователя

registerUser

POST https://api.wavesend.ru/json/1.3/registerUser

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

Request headers

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

Request body

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

200

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

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

Пример

{
  "request": {
    "userId": "user_3078a",                     // необязательный. Если пусто, используется hwid
    "application": "XXXXX-XXXXX",               // обязательный. Application code Wavesend
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // обязательный. Hardware device ID
    "tz_offset": -3600,                         // необязательный. Смещение временной зоны в секундах
    "device_type": 3                            // необязательный. Тип устройства, см. /registerDevice
                                                //           для получения списка типов устройств
  }
}

Note

Для email вызовите /registerEmailUser.

postEvent

POST https://api.wavesend.ru/json/1.3/postEvent

Вызывает event.

Request headers

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

Request body

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

200

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

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

Пример

{
  "request":{
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // обязательный. Hardware device ID, используемый в /registerDevice API.
                                                //           Может использоваться вместе с userId для идентификации
                                                //           пользователя, вызвавшего event.
    "application": "XXXXX-XXXXX",               // обязательный. Application code Wavesend
    "event": "activityCompleted",               // обязательный. Название Event, в точности как оно создано в Control Panel Wavesend
    "attributes": {                             // обязательный. Оставьте пустым, если не нужно передавать атрибуты.
      "login": "facebook",
      "success": "yes",
      "internet": "wifi"
    },
    "timestampUTC": 1435228403,                 // необязательный. Временная метка в UTC
    "timestampCurrent": 1435253603,             // необязательный. Временная метка в локальном времени
    "userId": "someuser@user.com",              // обязательный. user id, который используется для идентификации
                                                //           пользователей на нескольких устройствах. Может быть заменен
                                                //           или использоваться вместе с HWID.
    "device_type": 1                            // необязательный.
  }
}