Benutzerzentrierte API

registerUser

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

Verknüpft eine externe Benutzer-ID mit einem bestimmten Gerät.

Anfrage-Header

Name	Erforderlich	Wert	Beschreibung
Authorization	Ja	Token `XXXX`	API-Geräte-Token für den Zugriff auf die Geräte-API. Ersetzen Sie `XXXX` durch Ihr tatsächliches API-Geräte-Token.

Anfrage-Body

Name	Typ	Beschreibung
userId	string	Benutzer-ID, die mit einem Gerät verknüpft werden soll. Wenn leer, verwenden Sie hwid.
application*	string	Pushwoosh-Anwendungscode
hwid*	string	Pushwoosh-HWID
tz_offset	integer	Zeitzonenverschiebung in Sekunden für das Gerät.
device_type	integer	Gerätetyp. Siehe mögliche Werte in `/registerDevice`.

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

Kann später im API-Aufruf /createMessage verwendet werden (der Parameter users).
Es ist üblich, diese Funktion aufzurufen, bevor Sie das Push-Token haben und vor dem Aufruf von /registerDevice.

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

postEvent

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

Übermittelt das Ereignis.

Anfrage-Header

Name	Erforderlich	Wert	Beschreibung
Authorization	Ja	Token `XXXX`	API-Geräte-Token für den Zugriff auf die Geräte-API. Ersetzen Sie `XXXX` durch Ihr tatsächliches API-Geräte-Token.

Anfrage-Body

Name	Typ	Beschreibung
hwid*	string	Hardware-Geräte-ID, die in einer /registerDevice-Anfrage verwendet wurde. Kann zusammen mit ‘userId’ verwendet werden, um einen Benutzer zu identifizieren, der ein Ereignis ausgelöst hat.
application*	string	Pushwoosh-Anwendungscode
event*	string	Ereignisname, genau wie im Pushwoosh Control Panel erstellt.
attributes*	object	JSON-Objekt mit den Ereignisattributen. Lassen Sie es leer, wenn keine Attribute übergeben werden müssen.
timestampUTC	integer	Zeitstempel in UTC.
timestampCurrent	integer	Zeitstempel in Ortszeit.
userId*	string	Benutzer-ID, die mit einem Benutzer verknüpft ist, der das Ereignis ausgelöst hat. Kann durch eine HWID ersetzt oder zusammen mit dieser verwendet werden.
device_type	integer	Siehe mögliche Werte

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

Der Name des Ereignisses in der Anfrage muss mit dem Ereignisnamen im Pushwoosh Control Panel übereinstimmen. Beachten Sie, dass die Eigenschaft „attributes“ leer sein kann (aber nicht weggelassen werden darf), falls das Ereignis keine Attribute hat.

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