Applications API

createApplication

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

يقوم بإنشاء تطبيق جديد في الحساب.

Request Body

الاسم	النوع	الوصف
authorize_all_tokens	boolean	يسمح لجميع رموز API المميزة (tokens) بالتواصل مع هذا التطبيق.
auth*	string	API Access Token من Pushwoosh Control Panel.
icon	string	محتوى ثنائي مشفر بـ Base64 لملف png.
sdk_ios	string	نوع iOS SDK. القيم الممكنة: “pw” أو “corona”. بالنسبة لـ Corona، تكون حمولة الدفع (push payload) مختلفة.
sdk_android	string	نوع Android SDK. القيم الممكنة: “pw”، “corona”، “phonegap”. يختار مستخدمو AppPresser الخيار “phonegap”.
title*	string	عنوان التطبيق الجديد في Pushwoosh.

مثال على الاستجابة:

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "application": "1DC69-73EDB"
  }
}

مثال على الكود:

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",          // required. API access token from Pushwoosh Control Panel
    "icon": "iVBORw0KGgoAAAANSUhEUgAAA...",  // optional. Base-64 encoded binary content of png file
    "authorize_all_tokens": true,            // optional. If true, allows all api tokens to communicate with this app
    "sdk_ios": "pw",                         // optional. Possible values are "pw" or "corona"
    "sdk_android": "pw",                     // optional. Possible values are "pw", "corona", or "phonegap"
    "title": "APP_TITLE"                     // required. Title for the new app in Pushwoosh
  }
}

updateApplication

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

يقوم بتحديث إعدادات التطبيق.

Request Body

الاسم	النوع	الوصف
auth*	string	API Access Token من Pushwoosh Control Panel.
application*	string	Pushwoosh Application Code
icon	string	محتوى ثنائي مشفر بـ Base64 لملف png.
sdk_ios	string	نوع iOS SDK. القيم الممكنة: “pw” أو “corona”. بالنسبة لـ Corona، تكون حمولة الدفع (push payload) مختلفة.
sdk_android	string	نوع Android SDK. القيم الممكنة: “pw”، “corona”، “phonegap”. يختار مستخدمو AppPresser الخيار “phonegap”.
title	string	العنوان الجديد للتطبيق في Pushwoosh.

200

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

Example

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",     // required. API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX",       // required. application code of the app you want to update
    "icon": "iVBORw0KGgoAAAANSUD6...",  // optional. Base-64 encoded binary content of png file
    "sdk_ios": "pw",                    // optional. Possible values are "pw" or "corona"
    "sdk_android": "pw",                // optional. Possible values are "pw", "corona", or "phonegap"
    "title": "APP_TITLE"                // optional. New title for the app in Pushwoosh
  }
}

deleteApplication

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

يحذف التطبيق من الحساب.

Request Body

الاسم	النوع	الوصف
auth*	string	API Access Token من Pushwoosh Control Panel.
application*	string	Pushwoosh Application Code

200

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

Example

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX"    // required. Pushwoosh application code
  }
}

getApplication

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

يحصل على تفاصيل حول التطبيق.

Request Body

الاسم	النوع	الوصف
auth*	string	API Access Token من Pushwoosh Control Panel.
application*	string	Pushwoosh Application Code

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "application": {
      "adm_cid": "",
      "adm_secret": "",
      "android_api_type": "x31",
      "android_gcm_api_key": "x7836363631366236353566366236353739",
      "android_sdk": "x7077",
      "icon_url": null,
      "ios_gateway": "x783330",
      "ios_key_management_type": "x783631373537343666",
      "ios_key_password": "x7836353336363236353335333736353333",
      "ios_sdk": "x7077",
      "title": "0 Application For test",
      "providers": {
        "ios": true,
        "amazon": false,
        "android": false,
        "baidu_android": false,
        "chrome": false,
        "email": false,
        "firefox": false,
        "huawei_android": false,
        "internet_explorer": false,
        "osx": false,
        "safari": false,
        "sms": false,
        "web": false,
        "whats_app": false,
        "windows": false
      },
      "languages": {
        "en": "34",
        "zh": "12",
        "sv": "7",
        "de": "6",
        "pt": "6"
      }
    }
  }
}

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // required API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX"    // required. Pushwoosh application code
  }
}

getApplications

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

يحصل على قائمة التطبيقات في الحساب. يمكن إرجاع النتيجة مع ترقيم الصفحات.

Request Body

الاسم	النوع	الوصف
auth*	string	API Access Token من Pushwoosh Control Panel.
page	integer	رقم الصفحة لترقيم الصفحات.

Example request

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // required. API access token from Pushwoosh Control Panel
    "page": 2                        // optional. The page number for pagination
  }
}

Response

إذا كان هناك أكثر من 100 تطبيق في الحساب، تتضمن الاستجابة current page و total amount of pages.

Example Response

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "page": 1,   // Current page
    "total": 2,  // Total amount of pages
    "applications": [{
      "APPLICATION_CODE": "MyApp1"
    }, {
      "APPLICATION_CODE": "MyApp2"
    }]
  }
}

getApplicationFile

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

يحصل على ملفات التكوين المتعلقة بالتطبيق.

Request Body

الاسم	النوع	الوصف
auth*	string	API Access Token من Pushwoosh Control Panel.
application*	string	Pushwoosh Application Code
file*	string	معرف الملف المراد استرداده. انظر القيم أدناه.

200

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

Example

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // required. API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX",    // required. Pushwoosh application code
    "file": "ios_auto_privatekey"    // required. identifier of the file to retrieve. See values below
  }
}

القيم الممكنة للمعامل “file”:

"ios_auto_privatekey" | "ios_manual_privatekey" | "ios_auto_certificate" | "ios_manual_certificate" | "ios_push_certificate" | "ios_provisioning_profile" | "macos_manual_privatekey" | "macos_manual_certificate" | "macos_push_certificate" | "safari_manual_privatekey" | "safari_push_certificate" | "safari_push_package"

مثال على الاستجابة:

-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA PRIVATE KEY-----

setApplicationPlatformStatus

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

يغير حالة المنصة للتطبيق.

Request Body

الاسم	النوع	الوصف
auth*	string	API Access Token من Pushwoosh Control Panel.
application*	string	Pushwoosh Application Code
platform*	integer	نوع المنصة. انظر قائمة أنواع المنصات أدناه.
status*	string	”enable” أو “disable”

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "message": "iOS pushes are disabled",
    "available_platforms": {
      "iOS": false,
      "Android": true,
      "OS X": false,
      "Windows": false,
      "Amazon": false,
      "Safari": false,
      "Chrome": true,
      "Firefox": false,
    }
  }
}

Example

{
  "request": {
    "application": "XXXXX-XXXXX",   // required. Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel
    "platform": 1,                  // required. 1 — iOS; 3 — Android; 7 — Mac OS X; 8 — Windows;
                                    //           9 — Amazon; 10 — Safari; 11 — Chrome; 12 — Firefox;
    "status": "disable"             // required. "disable" or "enable"
  }
}