Пользовательский API

registerUser

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

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

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

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

Тело запроса

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

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

Пример запроса

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

Пример ответа

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

deleteUser

POST https://api.pushwoosh.com/api/v2/device-api/deleteUser

Удаляет пользователя и все устройства, связанные с указанным User ID в приложении. Запрос обрабатывается асинхронно, и конечная точка возвращает 200 OK, как только запрос на удаление будет принят в обработку.

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

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

Тело запроса

Имя	Обязательный	Тип	Описание
application	Да	string	Код приложения Pushwoosh
user_id	Да	string	User ID для удаления. Все устройства, связанные с этим пользователем в указанном приложении, будут удалены.

Пример запроса

{
  "application": "XXXXX-XXXXX",   // обязательно. Код приложения Pushwoosh
  "user_id": "user_3078a"         // обязательно. User ID для удаления
}

Пример ответа

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

Коды состояния

HTTP-статус	status_code	Описание
200	200	Запрос на удаление принят
200	210	Ошибка аргумента. Подробности см. в status_message.
400	N/A	Некорректная строка запроса
401	N/A	Отсутствует или недействителен токен авторизации
500	500	Внутренняя ошибка

postEvent

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

Инициирует событие.

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

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

Тело запроса

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

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

Пример запроса

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

Пример ответа

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