API centrada no usuário

registerUser

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

Associa um User ID externo a um dispositivo especificado.

Cabeçalhos da requisição

Nome	Obrigatório	Valor	Descrição
Authorization	Sim	Token `XXXX`	Token de Dispositivo da API para acessar a API de Dispositivo. Substitua `XXXX` pelo seu token real da API de Dispositivo.

Corpo da requisição

Nome	Tipo	Descrição
userId	string	User ID para associar a um dispositivo. Se vazio, usa o hwid.
application*	string	Código da aplicação Pushwoosh
hwid*	string	HWID da Pushwoosh
tz_offset	integer	Deslocamento de fuso horário em segundos para o dispositivo.
device_type	integer	Tipo de dispositivo. Veja os valores possíveis em `/registerDevice`.

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

Pode ser usado posteriormente na chamada de API /createMessage (o parâmetro users).
É normal chamar esta função antes de você ter o push token e antes da chamada /registerDevice.

{
  "request": {
    "userId": "user_3078a",                     // opcional. Se vazio, usa o hwid
    "application": "XXXXX-XXXXX",               // obrigatório. Código da aplicação Pushwoosh
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // obrigatório. ID de hardware do dispositivo
    "tz_offset": -3600,                         // opcional. Deslocamento de fuso horário em segundos
    "device_type": 3                            // opcional. Tipo de dispositivo, veja /registerDevice
                                                //           para tipos de dispositivo
  }
}

postEvent

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

Dispara o evento.

Cabeçalhos da requisição

Nome	Obrigatório	Valor	Descrição
Authorization	Sim	Token `XXXX`	Token de Dispositivo da API para acessar a API de Dispositivo. Substitua `XXXX` pelo seu token real da API de Dispositivo.

Corpo da requisição

Nome	Tipo	Descrição
hwid*	string	ID de hardware do dispositivo usado em uma requisição /registerDevice. Pode ser usado junto com ‘userId’ para identificar um usuário que disparou um evento.
application*	string	Código da aplicação Pushwoosh
event*	string	Nome do evento exatamente como criado no Painel de Controle da Pushwoosh.
attributes*	object	Objeto JSON com os atributos do evento. Deixe vazio se nenhum atributo precisar ser passado.
timestampUTC	integer	Timestamp em UTC.
timestampCurrent	integer	Timestamp no horário local.
userId*	string	User ID associado a um usuário que disparou o evento. Pode ser substituído por ou usado junto com um HWID.
device_type	integer	Veja os valores possíveis

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

O nome do evento na requisição deve corresponder ao nome do evento no Painel de Controle da Pushwoosh. Note que a propriedade “attributes” pode estar vazia (mas não omitida) caso o evento não tenha atributos.

{
  "request":{
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // obrigatório. ID de hardware do dispositivo usado em uma API /registerDevice.
                                                //           Pode ser usado junto com um userId para identificar um
                                                //           usuário que disparou um evento.
    "application": "XXXXX-XXXXX",               // obrigatório. Código da aplicação Pushwoosh
    "event": "activityCompleted",               // obrigatório. Nome do evento exatamente como criado no Painel de Controle da Pushwoosh
    "attributes": {                             // obrigatório. Deixe vazio se nenhum atributo precisar ser passado.
      "login": "facebook",
      "success": "yes",
      "internet": "wifi",
    },
    "timestampUTC": 1435228403,                 // opcional. Timestamp em UTC
    "timestampCurrent": 1435253603,             // opcional. Timestamp no horário local
    "userId": "someuser@user.com",              // obrigatório. Um user id que é usado para identificação de
                                                //           usuários em múltiplos dispositivos. Pode ser substituído por
                                                //           ou usado junto com um HWID.
    "device_type": 1                            // opcional.
  }
}