Benutzerzentrierte API

registerUser

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

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

Anfrage-Header

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

Anfrage-Body

Name	Erforderlich	Typ	Beschreibung
userId	Nein	string	User ID, die mit einem Gerät verknüpft werden soll. Wenn leer, wird hwid verwendet.
application	Ja	string	Pushwoosh-Anwendungscode
hwid	Ja	string	Pushwoosh HWID
tz_offset	Nein	integer	Zeitzonenversatz in Sekunden für das Gerät.
device_type	Nein	integer	Gerätetyp. Siehe mögliche Werte in `/registerDevice`.

Kann später im API-Aufruf /createMessage verwendet werden (der Parameter users).
Sie können diese Funktion aufrufen, bevor Sie das Push-Token haben und bevor der Aufruf /registerDevice erfolgt.

Anfragebeispiel

{
  "request": {
    "userId": "user_3078a",                     // optional. Wenn leer, wird hwid verwendet
    "application": "XXXXX-XXXXX",               // erforderlich. Pushwoosh-Anwendungscode
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // erforderlich. Hardware-Geräte-ID
    "tz_offset": -3600,                         // optional. Zeitzonenversatz in Sekunden
    "device_type": 3                            // optional. Gerätetyp, siehe /registerDevice
                                                //           für Gerätetypen
  }
}

Antwortbeispiel

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

deleteUser

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

Löscht einen Benutzer und alle Geräte, die mit der angegebenen User ID innerhalb der Anwendung verknüpft sind. Die Anfrage wird asynchron verarbeitet, und der Endpunkt gibt 200 OK zurück, sobald die Löschanfrage zur Verarbeitung angenommen wurde.

Anfrage-Header

Name	Erforderlich	Wert	Beschreibung
Authorization	Ja	Token `XXXX`	API Device Token für den Zugriff auf die Device API. Ersetzen Sie `XXXX` durch Ihr tatsächliches Device API Token.
Content-Type	Ja	application/json

Anfrage-Body

Name	Erforderlich	Typ	Beschreibung
application	Ja	string	Pushwoosh-Anwendungscode
user_id	Ja	string	User ID, die gelöscht werden soll. Alle Geräte, die mit diesem Benutzer in der angegebenen Anwendung verknüpft sind, werden entfernt.

Anfragebeispiel

{
  "application": "XXXXX-XXXXX",   // erforderlich. Pushwoosh-Anwendungscode
  "user_id": "user_3078a"         // erforderlich. Zu löschende User ID
}

Antwortbeispiel

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

Statuscodes

HTTP-Statuscode	status_code	Beschreibung
200	200	Löschanfrage angenommen
200	210	Argumentfehler. Siehe status_message für weitere Informationen.
400	N/A	Fehlerhafte Anforderungszeichenfolge
401	N/A	Fehlendes oder ungültiges Authorization-Token
500	500	Interner Fehler

postEvent

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

Löst ein Ereignis aus.

Anfrage-Header

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

Anfrage-Body

Name	Erforderlich	Typ	Beschreibung
hwid	Ja	string	Hardware-Geräte-ID, die in einer /registerDevice-Anfrage verwendet wird. Kann zusammen mit ‘userId’ verwendet werden, um einen Benutzer zu identifizieren, der ein Ereignis ausgelöst hat.
application	Ja	string	Pushwoosh-Anwendungscode
event	Ja	string	Ereignisname genau so, wie er im Pushwoosh Control Panel erstellt wurde.
attributes	Ja	object	JSON-Objekt mit den Ereignisattributen. Lassen Sie es leer, wenn keine Attribute übergeben werden müssen.
timestampUTC	Nein	integer	Zeitstempel in UTC.
timestampCurrent	Nein	integer	Zeitstempel in lokaler Zeit.
userId	Ja	string	User 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	Nein	integer	Siehe mögliche Werte

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.

Anfragebeispiel

{
  "request":{
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // erforderlich. Hardware-Geräte-ID, die in einer /registerDevice API verwendet wird.
                                                //           Kann zusammen mit einer userId verwendet werden, um einen
                                                //           Benutzer zu identifizieren, der ein Ereignis ausgelöst hat.
    "application": "XXXXX-XXXXX",               // erforderlich. Pushwoosh-Anwendungscode
    "event": "activityCompleted",               // erforderlich. Ereignisname genau so, wie er im Pushwoosh Control Panel erstellt wurde
    "attributes": {                             // erforderlich. Leer lassen, wenn keine Attribute übergeben werden müssen.
      "login": "facebook",
      "success": "yes",
      "internet": "wifi"
    },
    "timestampUTC": 1435228403,                 // optional. Zeitstempel in UTC
    "timestampCurrent": 1435253603,             // optional. Zeitstempel in lokaler Zeit
    "userId": "someuser@user.com",              // erforderlich. Eine Benutzer-ID, die zur Identifizierung von
                                                //           Benutzern auf mehreren Geräten verwendet wird. Kann ersetzt werden durch
                                                //           oder zusammen mit einer HWID verwendet werden.
    "device_type": 1                            // optional.
  }
}

Antwortbeispiel

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