App Configuration API
API methods to configure app platforms
configureApplication for iOS
Configures iOS platform for the app.
POST https://api.pushwoosh.com/json/1.3/configureApplication
Request Body
{
"status_code": 200,
"status_message": "OK",
"response": {
"providers": {
"ios": true,
"android": false,
"wp7": false,
"macos": false,
"blackberry": false,
"wns": false,
"adm": false,
"safari": false
}
}
}Example
{
"request":{
"auth": "yxoPUlwqm…………pIyEX4H", // required, API access token from Pushwoosh Control Panel
"application": "XXXXX-XXXXX", // required, Pushwoosh application code
"device_type": 1, // required, 1 - ios, 3 - android, 7 - osx, 8 - windows, 9 - amazon, 10 - safari
"ios_key_management_type": "manual", // required, "manual" (one step) | "auto" (few steps)
"ios_key_file": "MIIMY...BAQ==", // required, base64-encoded iOS key file content
"ios_key_password": "password", // required
"ios_gateway": "1", // required, "0" (sandbox) | "1" (production)
"ios_framework": "native" // required, possible values: "native", "cordova", "titanium", "marmalade", "adobeAir", "corona", "xamarin", "phoneGapBuild", "triggerIO", "unity"
}
}
configureApplication for Android
Configures Android platform for the app.
POST https://api.pushwoosh.com/json/1.3/configureApplication
Request Body
{
"status_code": 200,
"status_message": "OK",
"response": {
"providers": {
"ios": true,
"android": true,
"wp7": false,
"macos": false,
"blackberry": false,
"wns": false,
"adm": false,
"safari": 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-----\n****uH/OU/fILL****fMJZ+i6W****m8as.....\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"
}
}configureApplication for Mac OS X
Configures Mac OS X platform for the app.
POST https://api.pushwoosh.com/json/1.3/configureApplication
Request Body
{
"status_code": 200,
"status_message": "OK",
"response": {
"providers": {
"ios": true,
"android": true,
"wp7": true,
"macos": true,
"blackberry": false,
"wns": false,
"adm": false,
"safari": false
}
}
}Example
{
"request":{
"auth": "yxoPUlwqm…………pIyEX4H", // required, API access token from Pushwoosh Control Panel
"application": "XXXXX-XXXXX", // required, Pushwoosh application code
"device_type": 7, // 7 for OS X
"macos_key_management_type": "manual", // required, only "manual" available
"macos_cert_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // optional. Base64-encoded content of Mac OS X certificate file
"macos_key_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // optional. Base64-encoded content of Mac OS X key file
"macos_key_password": "PASSWORD", // optional. Key file password
"macos_gateway": 1 // required, push gateway. "0" for sandbox or "1" for production
}
}configureApplication for Windows 8
Configures Windows 8 platforms for the app.
POST https://api.pushwoosh.com/json/1.3/configureApplication
Request Body
{
"status_code": 200,
"status_message": "OK",
"response": {
"providers": {
"ios": true,
"android": true,
"wp7": true,
"macos": true,
"blackberry": true,
"wns": true,
"adm": false,
"safari": false
}
}
}Example
{
"request":{
"auth": "yxoPUlwqm…………pIyEX4H", // required, API access token from Pushwoosh Control Panel
"application": "XXXXX-XXXXX", // required, Pushwoosh application code
"device_type": 8, // 8 for Windows 8
"wns_psid": "ms-app://…", // required, package security identifier of the app from Windows Store
"wns_secret": "CLIENT_SECRET" // required, Windows client secret
}
}
configureApplication for Amazon
Configures Amazon platform for the app.
POST https://api.pushwoosh.com/json/1.3/configureApplication
Request Body
{
"status_code": 200,
"status_message": "OK",
"response": {
"providers": {
"ios": true,
"android": true,
"wp7": true,
"macos": true,
"blackberry": true,
"wns": true,
"adm": true,
"safari": false
}
}
}Example
{
"request":{
"auth": "yxoPUlwqm…………pIyEX4H", // required, API access token from Pushwoosh Control Panel
"application": "XXXXX-XXXXX", // required, Pushwoosh application code
"device_type": 9, // required, 9 for Amazon
"adm_cid": "CLIENT_ID", // required, Amazon client ID
"adm_secret": "CLIENT_SECRET", // required, Amazon Client Secret
"adm_framework": "native" // required, possible values: native, unity, adobeAir.
}
}configureApplication for Chrome
Configures Chrome platform for the app.
POST https://api.pushwoosh.com/json/1.3/configureApplication
Request Body
{
"status_code": 200,
"status_message": "OK",
"response": {
"providers": {
"ios": false,
"android": true,
"wp7": false,
"macos": false,
"blackberry": false,
"wns": false,
"adm": false,
"safari": false,
"asha": false,
"chrome": true
}
}
}{
"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-----\nn****uH/OU/fILL9****MJZ+i6W****m8as.....\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"
}
}
configureApplication for Safari
Configures Safari platform for the app.
POST https://api.pushwoosh.com/json/1.3/configureApplication
Request Body
{
"status_code": 200,
"status_message": "OK",
"response": {
"providers": {
"ios": false,
"android": false,
"wp7": false,
"macos": false,
"blackberry": false,
"wns": false,
"adm": false,
"safari": true
}
}
}Example
{
"request":{
"auth": "yxoPUlwqm…………pIyEX4H", // required, API access token from Pushwoosh Control Panel
"application": "XXXXX-XXXXX", // required, Pushwoosh application code
"device_type": 10, // required, 10 for Safari
"safari_key_management_type": "manual", // required, only "manual" available
"safari_website_name": "WEBSITE_NAME", // optional
"safari_allowed_domains": ["http://site1.com", "https://site2.com"], // optional
"safari_url_template": "https://%@", // required
"safari_icon_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // optional. Base64-encoded content of 256x256px png file
"safari_key_file": "MIIMY...BAQ==", // required, base64-encoded Safari .p12 key file content
"safari_key_password": "PASSWORD" // optional. Password to the key file above
}
}
configureApplication for Firefox
Configures Firefox platform for the app.
POST https://api.pushwoosh.com/json/1.3/configureApplication
Request Body
{
"status_code": 200,
"status_message": "OK",
"response": {
"providers": {
"ios": false,
"android": true,
"wp7": false,
"macos": false,
"blackberry": false,
"wns": false,
"adm": false,
"safari": false,
"asha": false,
"firefox": true
}
}
}{
"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"
}
}
configureApplication for Email
Configures Email platform for the app.
POST https://api.pushwoosh.com/json/1.3/configureApplication
Request Body
{
"status_code": 200,
"status_message": "OK",
"response": {
"providers": {
"ios": false,
"android": false,
"wp7": false,
"macos": false,
"blackberry": false,
"wns": false,
"adm": false,
"safari": false,
"email": true
}
}
}Example
{
"request":{
"auth": "yxoPUlwqm…………pIyEX4H", // required, API access token from Pushwoosh Control Panel
"application": "XXXXX-XXXXX", // required, Pushwoosh application code
"device_type": 14, // 14 for email
"email_from_email": "email@domain.com", // required, email address should be valid and verified
"email_from_name": "SENDER_NAME", // required, name to display in the "From" email field
"email_reply": "email@domain.com" // required, email address to reply should be valid and verified
}
}Last updated