API centrada no usuário

registerUser

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

Associa um ID de Usuário externo a um dispositivo especificado.

Cabeçalhos da solicitaçã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 solicitação

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

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

Exemplo de solicitação

{
  "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
  }
}

Exemplo de resposta

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

deleteUser

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

Exclui um usuário e todos os dispositivos associados ao ID do Usuário especificado dentro da aplicação. A solicitação é processada de forma assíncrona, e o endpoint retorna 200 OK assim que a solicitação de exclusão for aceita para processamento.

Cabeçalhos da solicitaçã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.
Content-Type	Sim	application/json

Corpo da solicitação

Nome	Obrigatório	Tipo	Descrição
application	Sim	string	Código da aplicação Pushwoosh
user_id	Sim	string	ID do Usuário a ser excluído. Todos os dispositivos associados a este usuário na aplicação especificada serão removidos.

Exemplo de solicitação

{
  "application": "XXXXX-XXXXX",   // required. Pushwoosh application code
  "user_id": "user_3078a"         // required. User ID to delete
}

Exemplo de resposta

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

Códigos de status

Código de status HTTP	status_code	Descrição
200	200	Solicitação de exclusão aceita
200	210	Erro de argumento. Veja status_message para mais informações.
400	N/A	String de solicitação malformada
401	N/A	Token de autorização ausente ou inválido
500	500	Erro interno

postEvent

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

Dispara um evento.

Cabeçalhos da solicitaçã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 solicitação

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

O nome do evento na solicitaçã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.

Exemplo de solicitação

{
  "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.
  }
}

Exemplo de resposta

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

Enviando eventos de conversão

Para relatar a receita diretamente em vez de mapear um evento existente, envie postEvent com PW_Conversion como o nome do evento e o value e currency da transação em attributes:

{
  "request":{
    "hwid": "8f65b16df378e7a6bece9614e1530fb2",
    "application": "XXXXX-XXXXX",
    "event": "PW_Conversion",
    "attributes": {
      "value": 49.99,               // required. Transaction amount
      "currency": "USD",            // required. ISO 4217 currency code
      "transaction_id": "txn_8f21", // optional. Your own transaction reference
      "product_id": "prod_premium"  // optional
    },
    "userId": "someuser@user.com"
  }
}