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
Configures iOS platform for the app.
Request Body
Name | Type | Description |
---|---|---|
auth | string | API access token from Pushwoosh Control Panel. |
application | string | Pushwoosh application code. |
device_type | integer | Must be 1 for iOS. |
ios_key_management_type | string | "manual" (one step) or "auto" (few steps). |
ios_key_file | string | Base64-encoded iOS key file content. |
ios_key_password | string | Password for iOS key file. |
ios_gateway | string | "0" for sandbox, "1" for production. |
ios_framework | string | Possible values: "native", "cordova", "titanium" |
configureApplication for Android
Configures Android platform for the app.
POST
https://api.pushwoosh.com/json/1.3/configureApplication
Configures Android platform for the app.
Request Body
Name | Type | Description |
---|---|---|
auth* | string | API access token from your Pushwoosh Control Panel. |
application* | string | Pushwoosh application code. |
device_type* | integer | Must be 3 for Android. |
android_gcm_api_key* | string | Android GCM/FCM API Key obtained from Firebase project settings. |
android_gcm_sender_id* | string | Android GCM/FCM Sender ID obtained from Firebase project settings. |
android_framework* | string | Android framework. Possible values: native, cordova, marmalade, adobeAir, corona, xamarin, phoneGapBuild, triggerIO, titanium, unity. |
android_fcm_service_account* | string | FCM service account key (JSON file generated in Firebase project settings). |
configureApplication for Mac OS X
Configures Mac OS X platform for the app.
POST
https://api.pushwoosh.com/json/1.3/configureApplication
Configures Mac OS X platform for the app.
Request Body
Name | Type | Description |
---|---|---|
auth* | string | API access token from Pushwoosh Control Panel. |
application* | string | Pushwoosh application code. |
device_type* | integer | Must be 7 for Mac OS X. |
macos_key_management_type* | string | Only "manual" type is available currently. |
macos_cert_file | string | Base64-encoded Mac OS X certificate file content. |
macos_key_file | string | Base64-encoded Mac OS X key file content. |
macos_key_password | string | Key file password. |
macos_gateway* | integer | Push gateway. "0" for sandbox, "1" for production. |
configureApplication for Windows 8
Configures Windows 8 platforms for the app.
POST
https://api.pushwoosh.com/json/1.3/configureApplication
Configures Windows 8 platforms for the app.
Request Body
Name | Type | Description |
---|---|---|
auth* | string | API access token from Pushwoosh Control Panel. |
application* | string | Pushwoosh application code. |
device_type* | integer | Must be 8 for Windows. |
wns_psid* | string | Package security identifier from Windows Store for the app. Starts with "ms-app://". |
wns_secret* | string | Client Secret from Windows Store for the app. |
configureApplication for Amazon
Configures Amazon platform for the app.
POST
https://api.pushwoosh.com/json/1.3/configureApplication
Configures Amazon platform for the app.
Request Body
Name | Type | Description |
---|---|---|
auth* | string | API access token from Pushwoosh Control Panel. |
application* | string | Pushwoosh application code. |
device_type* | integer | Must be 9 for Amazon. |
adm_cid* | string | Amazon client ID. |
adm_secret* | string | Amazon client secret. |
adm_framework* | string | Amazon framework. Possible values: native, unity, adobeAir. |
configureApplication for Chrome
Configures Chrome platform for the app.
POST
https://api.pushwoosh.com/json/1.3/configureApplication
Configures Chrome platform for the app.
Request Body
Name | Type | Description |
---|---|---|
auth* | string | API access token from Pushwoosh Control Panel. |
application* | string | Pushwoosh application code. |
device_type* | integer | Must be 11 for Chrome. |
chrome_gcm_api_key* | string | GCM/FCM API key for Google Chrome. |
chrome_gcm_project_number* | string | GCM/FCM Project number. |
chrome_fcm_service_account* | string | FCM service account key (JSON file generated in Firebase project settings). |
configureApplication for Safari
Configures Safari platform for the app.
POST
https://api.pushwoosh.com/json/1.3/configureApplication
Configures Safari platform for the app.
Request Body
Name | Type | Description |
---|---|---|
auth* | string | API access token from Pushwoosh Control Panel. |
application* | string | Pushwoosh application code. |
device_type* | integer | Must be 10 for Safari. |
safari_key_management_type* | string | Only "manual" type is available currently. |
safari_website_name | string | Website name. |
safari_allowed_domains | array | Ex: [http://site1.com/", https://site2.com"] |
safari_url_template* | string | Safari URL template formatted as "https://%@". |
safari_icon_file | string | Base64-encoded content of 256x256px png file. |
safari_key_file* | string | Base64-encoded Safari .p12 key file content. |
safari_key_password | string | Password to the key file. |
configureApplication for Firefox
Configures Firefox platform for the app.
POST
https://api.pushwoosh.com/json/1.3/configureApplication
Configures Firefox platform for the app.
Request Body
Name | Type | Description |
---|---|---|
auth* | string | API access token from Pushwoosh Control Panel. |
application* | string | Pushwoosh application code. |
device_type* | integer | Must be 12 for Firefox. |
firefox_is_enabled | boolean | Enables push notifications for Firefox. |
fcm_sender_id | string | GCM/FCM Sender ID for Firefox. |
fcm_api_key | string | GCM/FCM API Key for Firefox. |
firefox_fcm_service_account* | object | JSON generated in Firebase project settings. |
configureApplication for Email
Configures Email platform for the app.
POST
https://api.pushwoosh.com/json/1.3/configureApplication
Configures Email platform for the app.
Request Body
Name | Type | Description |
---|---|---|
auth* | string | API access token from Pushwoosh Control Panel. |
application* | string | Pushwoosh application code. |
device_type* | integer | Must be 14 for Email. |
email_from_email* | string | Sender email address. Should be valid and verified. |
email_from_name* | string | Sender name. |
email_reply* | string | Email address to reply to. Should be valid and verified. |
Last updated