API centrada en el usuario
registerUser
Anchor link toPOST https://api.pushwoosh.com/json/1.3/registerUser
Asocia un User ID externo con un dispositivo específico.
Encabezados de la solicitud
Anchor link to| Nombre | Requerido | Valor | Descripción |
|---|---|---|---|
| Authorization | Sí | Token XXXX | Token de Dispositivo de API para acceder a la API de Dispositivo. Reemplace XXXX con su token de API de Dispositivo real. |
Cuerpo de la solicitud
Anchor link to| Nombre | Tipo | Descripción |
|---|---|---|
| userId | string | User ID para asociar con un dispositivo. Si está vacío, use hwid. |
| application* | string | Código de aplicación de Pushwoosh |
| hwid* | string | HWID de Pushwoosh |
| tz_offset | integer | Desplazamiento de zona horaria en segundos para el dispositivo. |
| device_type | integer | Tipo de dispositivo. Vea los valores posibles en /registerDevice. |
{ "status_code": 200, "status_message": "OK", "response": null}Se puede utilizar más tarde en la llamada a la API /createMessage (el parámetro users).
Es normal llamar a esta función antes de tener el token push y antes de la llamada a /registerDevice.
{ "request": { "userId": "user_3078a", // opcional. Si está vacío, use hwid "application": "XXXXX-XXXXX", // requerido. Código de aplicación de Pushwoosh "hwid": "8f65b16df378e7a6bece9614e1530fb2", // requerido. ID de dispositivo de hardware "tz_offset": -3600, // opcional. Desplazamiento de zona horaria en segundos "device_type": 3 // opcional. Tipo de dispositivo, ver /registerDevice // para tipos de dispositivos }}postEvent
Anchor link toPOST https://api.pushwoosh.com/json/1.3/postEvent
Registra el evento.
Encabezados de la solicitud
Anchor link to| Nombre | Requerido | Valor | Descripción |
|---|---|---|---|
| Authorization | Sí | Token XXXX | Token de Dispositivo de API para acceder a la API de Dispositivo. Reemplace XXXX con su token de API de Dispositivo real. |
Cuerpo de la solicitud
Anchor link to| Nombre | Tipo | Descripción |
|---|---|---|
| hwid* | string | ID de dispositivo de hardware utilizado en una solicitud /registerDevice. Se puede usar junto con ‘userId’ para identificar a un usuario que ha activado un evento. |
| application* | string | Código de aplicación de Pushwoosh |
| event* | string | Nombre del evento exactamente como se creó en el Panel de Control de Pushwoosh. |
| attributes* | object | Objeto JSON con los atributos del evento. Déjelo vacío si no es necesario pasar atributos. |
| timestampUTC | integer | Marca de tiempo en UTC. |
| timestampCurrent | integer | Marca de tiempo en hora local. |
| userId* | string | User ID asociado con un usuario que ha activado el evento. Puede ser reemplazado por o usado junto con un HWID. |
| device_type | integer | Ver valores posibles |
{ "status_code": 200, "status_message": "OK", "response": { "code": "61BC9-84DD0" }}El nombre del evento en la solicitud debe coincidir con el nombre del evento en el Panel de Control de Pushwoosh. Tenga en cuenta que la propiedad “attributes” puede estar vacía (pero no omitida) en caso de que el evento no tenga atributos.
{ "request":{ "hwid": "8f65b16df378e7a6bece9614e1530fb2", // requerido. ID de dispositivo de hardware usado en una API /registerDevice. // Se puede usar junto con un userId para identificar a un // usuario que ha activado un evento. "application": "XXXXX-XXXXX", // requerido. Código de aplicación de Pushwoosh "event": "activityCompleted", // requerido. Nombre del evento exactamente como se creó en el Panel de Control de Pushwoosh "attributes": { // requerido. Dejar vacío si no es necesario pasar atributos. "login": "facebook", "success": "yes", "internet": "wifi", }, "timestampUTC": 1435228403, // opcional. Marca de tiempo en UTC "timestampCurrent": 1435253603, // opcional. Marca de tiempo en hora local "userId": "someuser@user.com", // requerido. Un user id que se usa para la identificación de // usuarios en múltiples dispositivos. Puede ser reemplazado por // o usado junto con un HWID. "device_type": 1 // opcional. }}