User centric API

registerUser

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

يربط User ID خارجي بجهاز محدد.

Request headers

الاسم	مطلوب	القيمة	الوصف
Authorization	نعم	Token `XXXX`	API Device Token للوصول إلى Device API. استبدل `XXXX` بـ Device API token الفعلي الخاص بك.

Request body

الاسم	النوع	الوصف
userId	string	User ID لربطه بجهاز. إذا كان فارغاً، استخدم hwid.
application*	string	Pushwoosh application code
hwid*	string	Pushwoosh HWID
tz_offset	integer	إزاحة المنطقة الزمنية (Timezone offset) بالثواني للجهاز.
device_type	integer	Device type. انظر القيم الممكنة في `/registerDevice`.

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

يمكن استخدامه لاحقاً في استدعاء API /createMessage (المعلمة users).
من الطبيعي استدعاء هذه الدالة قبل الحصول على push token وقبل استدعاء /registerDevice.

{
  "request": {
    "userId": "user_3078a",                     // اختياري. إذا كان فارغاً، استخدم hwid
    "application": "XXXXX-XXXXX",               // مطلوب. Pushwoosh application code
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // مطلوب. Hardware device ID
    "tz_offset": -3600,                         // اختياري. إزاحة المنطقة الزمنية بالثواني
    "device_type": 3                            // اختياري. نوع الجهاز، انظر /registerDevice
                                                //           لأنواع الأجهزة
  }
}

postEvent

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

يستدعي الحدث (event).

Request headers

الاسم	مطلوب	القيمة	الوصف
Authorization	نعم	Token `XXXX`	API Device Token للوصول إلى Device API. استبدل `XXXX` بـ Device API token الفعلي الخاص بك.

Request body

الاسم	النوع	الوصف
hwid*	string	Hardware device ID المستخدم في طلب /registerDevice. يمكن استخدامه جنباً إلى جنب مع ‘userId’ لتحديد المستخدم الذي قام بتشغيل الحدث.
application*	string	Pushwoosh application code
event*	string	Event name تماماً كما تم إنشاؤه في Pushwoosh Control Panel.
attributes*	object	كائن JSON يحتوي على سمات الحدث (event attributes). اتركه فارغاً إذا لم تكن هناك حاجة لتمرير أي سمات.
timestampUTC	integer	الطابع الزمني (Timestamp) بالتوقيت العالمي المنسق (UTC).
timestampCurrent	integer	الطابع الزمني (Timestamp) بالتوقيت المحلي.
userId*	string	User ID المرتبط بالمستخدم الذي قام بتشغيل الحدث. يمكن استبداله بـ HWID أو استخدامه معه.
device_type	integer	انظر القيم الممكنة

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

يجب أن يتطابق اسم الحدث في الطلب مع اسم الحدث في Pushwoosh Control Panel. لاحظ أن الخاصية “attributes” قد تكون فارغة (ولكن لا يمكن حذفها) في حال لم يكن للحدث أي سمات.

{
  "request":{
    "hwid": "8f65b16df378e7a6bece9614e1530fb2", // مطلوب. Hardware device ID المستخدم في /registerDevice API.
                                                //           يمكن استخدامه مع userId لتحديد
                                                //           المستخدم الذي قام بتشغيل الحدث.
    "application": "XXXXX-XXXXX",               // مطلوب. Pushwoosh application code
    "event": "activityCompleted",               // مطلوب. اسم الحدث تماماً كما تم إنشاؤه في Pushwoosh Control Panel
    "attributes": {                             // مطلوب. اتركه فارغاً إذا لم تكن هناك حاجة لتمرير سمات.
      "login": "facebook",
      "success": "yes",
      "internet": "wifi",
    },
    "timestampUTC": 1435228403,                 // اختياري. الطابع الزمني بـ UTC
    "timestampCurrent": 1435253603,             // اختياري. الطابع الزمني بالتوقيت المحلي
    "userId": "someuser@user.com",              // مطلوب. user id يستخدم لتعريف
                                                //           المستخدمين على أجهزة متعددة. يمكن استبداله بـ
                                                //           أو استخدامه مع HWID.
    "device_type": 1                            // اختياري.
  }
}