ऐप कॉन्फ़िगरेशन API

ऐप कॉन्फ़िगरेशन API किसी मौजूदा Pushwoosh एप्लिकेशन के प्लेटफ़ॉर्म सेट करता है, जैसे iOS कुंजी फ़ाइल या Android FCM सर्विस अकाउंट। सभी प्लेटफ़ॉर्म एक ही /configureApplication विधि का उपयोग करते हैं, और नीचे दिए गए सेक्शन प्रत्येक प्लेटफ़ॉर्म के लिए अनुरोध पैरामीटर सूचीबद्ध करते हैं। स्वयं एप्लिकेशन बनाने के लिए, एप्लिकेशन API का उपयोग करें।

iOS के लिए configureApplication

ऐप के लिए iOS प्लेटफ़ॉर्म कॉन्फ़िगर करता है।

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

रिक्वेस्ट बॉडी

नाम	प्रकार	विवरण
auth	string	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन
application	string	Pushwoosh एप्लिकेशन कोड
device_type	integer	iOS के लिए 1 होना चाहिए
ios_key_management_type	string	”manual”
ios_key_file	string	Base64-एन्कोडेड iOS की फ़ाइल कंटेंट
ios_key_password	string	iOS की फ़ाइल के लिए पासवर्ड
ios_gateway	integer	सैंडबॉक्स के लिए “0”, प्रोडक्शन के लिए “1”
ios_framework	string	संभावित मान: “native”, “cordova”, “titanium”

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": true,
      "amazon": false,
      "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
    }
  }
}

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",      // आवश्यक। Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन
    "application": "XXXXX-XXXXX",        // आवश्यक। Pushwoosh एप्लिकेशन कोड
    "device_type": 1,                    // आवश्यक। iOS के लिए 1
    "ios_key_management_type": "manual", // आवश्यक। "manual"
    "ios_key_file": "MIIMY...BAQ==",     // आवश्यक। base64-एन्कोडेड iOS की फ़ाइल कंटेंट
    "ios_key_password": "password",      // आवश्यक।
    "ios_gateway": 1,                    // आवश्यक। "0" (सैंडबॉक्स) | "1" (प्रोडक्शन)
    "ios_framework": "native"            // आवश्यक। संभावित मान: "native", "cordova", "titanium",
                                         //           "marmalade", "adobeAir", "corona", "xamarin",
                                         //           "phoneGapBuild", "triggerIO", "unity"
  }
}

Android के लिए configureApplication

ऐप के लिए Android प्लेटफ़ॉर्म कॉन्फ़िगर करता है।

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

रिक्वेस्ट बॉडी

नाम	प्रकार	विवरण
auth*	string	आपके Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application*	string	Pushwoosh एप्लिकेशन कोड
device_type*	integer	Android के लिए 3 होना चाहिए।
android_framework*	string	Android फ्रेमवर्क। संभावित मान: native, cordova, marmalade, adobeAir, corona, xamarin, phoneGapBuild, triggerIO, titanium, unity।
android_fcm_service_account*	object	FCM सर्विस अकाउंट की (Firebase प्रोजेक्ट सेटिंग्स में जेनरेट की गई JSON फ़ाइल)।

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "amazon": false,
      "android": true,
      "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
    }
  }
}

उदाहरण

{
  "request": {
    "auth": "Z2PLR....IRwTqHwCr",
    "application": "87E33-XXXXX",
    "device_type": 3,
    "android_fcm_service_account": {
      "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
      "auth_uri": "https://accounts.google.com/o/oauth2/auth",
      "client_email": "****@foobar.iam.gserviceaccount.com",
      "client_id": "115********6584854983",
      "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/firebase-adminsdk-zffgu%40foobar.iam.gserviceaccount.com",
      "private_key": "-----BEGIN PRIVATE KEY-----\nuH/OU/fIL+i6Wm8as...\n-----END PRIVATE KEY-----\n",
      "private_key_id": "e3749********6d9",
      "project_id": "app-android",
      "token_uri": "https://oauth2.googleapis.com/token",
      "type": "service_account",
      "universe_domain": "googleapis.com"
    },
    "android_framework": "native"
  }
}

Mac OS X के लिए configureApplication

ऐप के लिए Mac OS X प्लेटफ़ॉर्म कॉन्फ़िगर करता है।

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

रिक्वेस्ट बॉडी

नाम	प्रकार	विवरण
auth*	string	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application*	string	Pushwoosh एप्लिकेशन कोड
device_type*	integer	Mac OS X के लिए 7 होना चाहिए।
macos_key_management_type*	string	वर्तमान में केवल “manual” प्रकार उपलब्ध है।
macos_cert_file	string	Base64-एन्कोडेड Mac OS X सर्टिफिकेट फ़ाइल कंटेंट।
macos_key_file	string	Base64-एन्कोडेड Mac OS X की फ़ाइल कंटेंट।
macos_key_password	string	की फ़ाइल पासवर्ड।
macos_gateway*	integer	पुश गेटवे। सैंडबॉक्स के लिए “0”, प्रोडक्शन के लिए “1”।

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "amazon": false,
      "android": false,
      "chrome": false,
      "email": false,
      "firefox": false,
      "huawei_android": false,
      "internet_explorer": false,
      "osx": true,
      "safari": false,
      "sms": false,
      "web": false,
      "whats_app": false,
      "windows": false
    }
  }
}

{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",                   // आवश्यक। Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन
    "application": "XXXXX-XXXXX",                     // आवश्यक। Pushwoosh एप्लिकेशन कोड
    "device_type": 7,                                 // आवश्यक। Mac OS X के लिए 7
    "macos_key_management_type": "manual",            // आवश्यक। "manual"
    "macos_cert_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // वैकल्पिक। Mac OS X सर्टिफिकेट फ़ाइल का Base64-एन्कोडेड कंटेंट
    "macos_key_file": "iVBORw0KGgoAAAANSUhEUgAABB…",  // वैकल्पिक। Mac OS X की फ़ाइल का Base64-एन्कोडेड कंटेंट
    "macos_key_password": "PASSWORD",                 // वैकल्पिक। की फ़ाइल पासवर्ड
    "macos_gateway": 1                                // आवश्यक। पुश गेटवे। सैंडबॉक्स के लिए "0" या प्रोडक्शन के लिए "1"
  }
}

Windows के लिए configureApplication

ऐप के लिए Windows प्लेटफ़ॉर्म कॉन्फ़िगर करता है।

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

रिक्वेस्ट बॉडी

नाम	प्रकार	विवरण
auth*	string	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application*	string	Pushwoosh एप्लिकेशन कोड
device_type*	integer	Windows के लिए 8 होना चाहिए।
wns_psid*	string	ऐप के लिए Windows Store से पैकेज सुरक्षा पहचानकर्ता। “ms-app://” से शुरू होता है।
wns_secret*	string	ऐप के लिए Windows Store से क्लाइंट सीक्रेट।

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "amazon": false,
      "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": true
    }
  }
}

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // आवश्यक। Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन
    "application": "XXXXX-XXXXX",    // आवश्यक। Pushwoosh एप्लिकेशन कोड
    "device_type": 8,                // आवश्यक। Windows के लिए 8
    "wns_psid": "ms-app://…",        // आवश्यक। Windows Store से ऐप का पैकेज सुरक्षा पहचानकर्ता
    "wns_secret": "CLIENT_SECRET"    // आवश्यक। Windows क्लाइंट सीक्रेट
  }
}

Amazon के लिए configureApplication

ऐप के लिए Amazon प्लेटफ़ॉर्म कॉन्फ़िगर करता है।

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

रिक्वेस्ट बॉडी

नाम	प्रकार	विवरण
auth*	string	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application*	string	Pushwoosh एप्लिकेशन कोड
device_type*	integer	Amazon के लिए 9 होना चाहिए।
adm_cid*	string	Amazon क्लाइंट आईडी।
adm_secret*	string	Amazon क्लाइंट सीक्रेट।
adm_framework*	string	Amazon फ्रेमवर्क। संभावित मान: native, unity, adobeAir.

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "amazon": true,
      "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
    }
  }
}

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // आवश्यक। Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन
    "application": "XXXXX-XXXXX",    // आवश्यक। Pushwoosh एप्लिकेशन कोड
    "device_type": 9,                // आवश्यक। Amazon के लिए 9
    "adm_cid": "CLIENT_ID",          // आवश्यक। Amazon क्लाइंट आईडी
    "adm_secret": "CLIENT_SECRET",   // आवश्यक। Amazon क्लाइंट सीक्रेट
    "adm_framework": "native"        // आवश्यक। संभावित मान: native, unity, adobeAir.
  }
}

Chrome के लिए configureApplication

ऐप के लिए Chrome प्लेटफ़ॉर्म कॉन्फ़िगर करता है।

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

रिक्वेस्ट बॉडी

नाम	प्रकार	विवरण	आवश्यक
auth*	string	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।	आवश्यक
application*	string	Pushwoosh एप्लिकेशन कोड	आवश्यक
device_type*	integer	Chrome के लिए 11 होना चाहिए।	आवश्यक
chrome_fcm_service_account*	object	FCM सर्विस अकाउंट की (Firebase प्रोजेक्ट सेटिंग्स में जेनरेट की गई JSON फ़ाइल)।	आवश्यक
chrome_vapid_key*	string	Chrome में पुश नोटिफिकेशन प्रमाणीकरण के लिए उपयोग की जाने वाली पब्लिक VAPID (वॉलंटरी एप्लिकेशन सर्वर आइडेंटिफिकेशन) की।	आवश्यक
chrome_vapid_private_key*	string	Chrome में पुश नोटिफिकेशन पर हस्ताक्षर करने और भेजने के लिए उपयोग की जाने वाली प्राइवेट VAPID की।	आवश्यक

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "amazon": false,
      "android": false,
      "chrome": true,
      "email": false,
      "firefox": false,
      "huawei_android": false,
      "internet_explorer": false,
      "osx": false,
      "safari": false,
      "sms": false,
      "web": false,
      "whats_app": false,
      "windows": false
    }
  }
}

उदाहरण

{
  "request": {
    "auth": "Z2PLR....IRwTqHwCr",
    "application": "87E33-XXXXX",
    "device_type": 11,
    "chrome_fcm_service_account": {
      "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
      "auth_uri": "https://accounts.google.com/o/oauth2/auth",
      "client_email": "****@foobar.iam.gserviceaccount.com",
      "client_id": "11529......6584854983",
      "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/****foobar.iam.gserviceaccount.com",
      "private_key": "-----BEGIN PRIVATE KEY-----\nuH/OU/fIm8as...\n-----END PRIVATE KEY-----\n",
      "private_key_id": "e3749......e66d9",
      "project_id": "app-chrome",
      "token_uri": "https://oauth2.googleapis.com/token",
      "type": "service_account",
      "universe_domain": "googleapis.com"
    },
    "chrome_vapid_key": "BEr....KPqQvCbU",
    "chrome_vapid_private_key": "ee....flOqmSo"
  }
}

Safari के लिए configureApplication

ऐप के लिए Safari प्लेटफ़ॉर्म कॉन्फ़िगर करता है।

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

रिक्वेस्ट बॉडी

नाम	प्रकार	विवरण
auth*	string	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application*	string	Pushwoosh एप्लिकेशन कोड
device_type*	integer	Safari के लिए 10 होना चाहिए।
safari_key_management_type*	string	वर्तमान में केवल “manual” प्रकार उपलब्ध है।
safari_website_name	string	वेबसाइट का नाम।
safari_allowed_domains	array	उदा: https://site1.com”, https://site2.com”
safari_url_template*	string	Safari URL टेम्पलेट “https://%@” के रूप में स्वरूपित है।
safari_icon_file	string	256x256px png फ़ाइल का Base64-एन्कोडेड कंटेंट।
safari_key_file*	string	Base64-एन्कोडेड Safari .p12 की फ़ाइल कंटेंट।
safari_key_password	string	की फ़ाइल का पासवर्ड।

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "amazon": false,
      "android": false,
      "chrome": false,
      "email": false,
      "firefox": false,
      "huawei_android": false,
      "internet_explorer": false,
      "osx": false,
      "safari": true,
      "sms": false,
      "web": false,
      "whats_app": false,
      "windows": false
    }
  }
}

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",                    // आवश्यक। Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन
    "application": "XXXXX-XXXXX",                      // आवश्यक। Pushwoosh एप्लिकेशन कोड
    "device_type": 10,                                 // आवश्यक। Safari के लिए 10
    "safari_key_management_type": "manual",            // आवश्यक। "manual"
    "safari_website_name": "WEBSITE_NAME",             // वैकल्पिक।
    "safari_allowed_domains": [                        // वैकल्पिक।
      "https://site1.com",
      "https://site2.com"
    ],
    "safari_url_template": "https://%@",               // आवश्यक।
    "safari_icon_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // वैकल्पिक। 256x256px png फ़ाइल का Base64-एन्कोडेड कंटेंट
    "safari_key_file": "MIIMY...BAQ==",                // आवश्यक। base64-एन्कोडेड Safari .p12 की फ़ाइल कंटेंट
    "safari_key_password": "PASSWORD"                  // वैकल्पिक। ऊपर दी गई की फ़ाइल का पासवर्ड
  }
}

Firefox के लिए configureApplication

ऐप के लिए Firefox प्लेटफ़ॉर्म कॉन्फ़िगर करता है।

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

रिक्वेस्ट बॉडी

नाम	प्रकार	विवरण	आवश्यक
auth*	string	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।	आवश्यक
application*	string	Pushwoosh एप्लिकेशन कोड	आवश्यक
device_type*	integer	Firefox के लिए 12 होना चाहिए।	आवश्यक
firefox_is_enabled	boolean	Firefox के लिए पुश नोटिफिकेशन सक्षम करता है।	वैकल्पिक
firefox_fcm_service_account*	object	Firebase प्रोजेक्ट सेटिंग्स में जेनरेट किया गया JSON।	आवश्यक
firefox_vapid_key*	string	Firefox में पुश नोटिफिकेशन प्रमाणीकरण के लिए उपयोग की जाने वाली पब्लिक VAPID (वॉलंटरी एप्लिकेशन सर्वर आइडेंटिफिकेशन) की।	आवश्यक
firefox_vapid_private_key*	string	Firefox में पुश नोटिफिकेशन पर हस्ताक्षर करने और भेजने के लिए उपयोग की जाने वाली प्राइवेट VAPID की।	आवश्यक

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "amazon": false,
      "android": false,
      "chrome": false,
      "email": false,
      "firefox": true,
      "huawei_android": false,
      "internet_explorer": false,
      "osx": false,
      "safari": false,
      "sms": false,
      "web": false,
      "whats_app": false,
      "windows": false
    }
  }
}

उदाहरण

{
  "request": {
    "auth": "Z2PLR....IRwTqHwCr",
    "application": "87E33-XXXXX",
    "device_type": 12,
    "firefox_fcm_service_account": {
      "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
      "auth_uri": "https://accounts.google.com/o/oauth2/auth",
      "client_email": "****@foobar.iam.gserviceaccount.com",
      "client_id": "115........6584854983",
      "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/****@foobar.iam.gserviceaccount.com",
      "private_key": "-----BEGIN PRIVATE KEY-----\n****uH/OU/fILL****fMJZ+i6****um8as.....\n-----END PRIVATE KEY-----\n",
      "private_key_id": "e3........8e66d9",
      "project_id": "app-firefox",
      "token_uri": "https://oauth2.googleapis.com/token",
      "type": "service_account",
      "universe_domain": "googleapis.com"
    },
    "firefox_vapid_key": "BEr....KPqQvCbU",
    "firefox_vapid_private_key": "ee....flOqmSo"
  }
}

Email के लिए configureApplication

ऐप के लिए Email प्लेटफ़ॉर्म कॉन्फ़िगर करता है।

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

रिक्वेस्ट बॉडी

नाम	प्रकार	विवरण
auth*	string	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application*	string	Pushwoosh एप्लिकेशन कोड
device_type*	integer	Email के लिए 14 होना चाहिए।
email_from_email*	string	प्रेषक का ईमेल पता। वैध और सत्यापित होना चाहिए।
email_from_name*	string	प्रेषक का नाम।
email_reply*	string	जवाब देने के लिए ईमेल पता। वैध और सत्यापित होना चाहिए।

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "amazon": false,
      "android": false,
      "chrome": false,
      "email": true,
      "firefox": false,
      "huawei_android": false,
      "internet_explorer": false,
      "osx": false,
      "safari": false,
      "sms": false,
      "web": false,
      "whats_app": false,
      "windows": false
    }
  }
}

{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",         // आवश्यक। Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन
    "application": "XXXXX-XXXXX",           // आवश्यक। Pushwoosh एप्लिकेशन कोड
    "device_type": 14,                      // आवश्यक। ईमेल के लिए 14
    "email_from_email": "email@domain.com", // आवश्यक। ईमेल पता वैध और सत्यापित होना चाहिए
    "email_from_name": "SENDER_NAME",       // आवश्यक। "From" ईमेल फ़ील्ड में प्रदर्शित होने वाला नाम
    "email_reply": "email@domain.com"       // आवश्यक। जवाब देने के लिए ईमेल पता वैध और सत्यापित होना चाहिए
  }
}