App Configuration

configureApplication for iOS
post
https://cp.pushwoosh.com/json/1.3
/configureApplication
/configureApplication for iOS
For Private Offering subscriptions only.
Example
1
{
2
  "request":{
3
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
    "application": "XXXXX-XXXXX", // Pushwoosh application code
5
    "device_type": 1, // 1 - ios, 3 - android, 5 - windows phone, 7 - osx, 8 - windows, 9 - amazon, 10 - safari
6
    "ios_key_management_type": "manual", // "manual" (one step) | "auto" (few steps)
7
    "ios_key_file": "MIIMY...BAQ==", // base64-encoded iOS key file content
8
    "ios_key_password": "password",
9
    "ios_gateway": "1", // "0" (sandbox) | "1" (production)
10
    "ios_framework": "native" // possible values: "native", "cordova", "titanium", "marmalade", "adobeAir", "corona", "xamarin", "phoneGapBuild", "triggerIO", "unity"
11
  }
12
}
13
​
14
​
Copied!
Auto configuration
Step 1 Create an app and provide your Apple ID information.
Request
Response
1
{
2
  "request":{
3
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
    "application": "XXXXX-XXXXX", // Pushwoosh application code
5
    "device_type": 1,
6
    "ios_key_management_type": "auto",
7
    "step": "1",
8
    "ios_apple_id": "[email protected]",
9
    "ios_apple_password": "xxxxxx",
10
    "ios_framework": "native" // possible values: "native", "cordova", "titanium", "marmalade", "adobeAir", "corona", "xamarin", "phoneGapBuild", "triggerIO", "unity"
11
  }
12
}
Copied!
1
{
2
  "status_code": 200,
3
  "status_message": "OK",
4
  "response": {
5
    "step_data": {
6
      "teams": {
7
        "12345ABCDE": {
8
          "name": "Pushwoosh team",
9
          "memberid": "XXXXXXXXXX"
10
        }
11
      },
12
      "step": 2 // proceed to step 2
13
    }
14
  }
15
}
Copied!
Step 2 Select the Team ID.
Request
Response
1
{
2
  "request":{
3
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
    "application": "XXXXX-XXXXX", // Pushwoosh application code
5
    "device_type": 1,
6
    "ios_key_management_type": "auto",
7
    "step": "2",
8
    "ios_apple_id": "[email protected]",
9
    "ios_apple_password": "xxxxxx",
10
    "ios_framework": "native", // possible values: "native", "cordova", "titanium", "marmalade", "adobeAir", "corona", "xamarin", "phoneGapBuild", "triggerIO", "unity"
11
    "team_id":"12345ABCDE"
12
 }
13
}
Copied!
1
{
2
  "status_code": 200,
3
  "status_message": "OK",
4
  "response": {
5
    "step_data": {
6
      "appids": [
7
        {
8
          "appIdId": "67890FGHIJ",
9
          "name": "My Application",
10
          "appIdPlatform": "ios",
11
          "prefix": "12345ABCDE",
12
          "identifier": "com.xxxxxxx.xxxxxxx",
13
          "isWildCard": false,
14
          "isDuplicate": false,
15
          "features": {
16
            "push": true,
17
            "iCloud": false,
18
            "inAppPurchase": true,
19
            "gameCenter": true,
20
            "XXXXXXXXXX": false,
21
            "passbook": false,
22
            "YYYYYYYYYY": false,
23
            "dataProtection": ""
24
          },
25
          "enabledFeatures": [
26
            "push",
27
            "inAppPurchase",
28
            "gameCenter"
29
          ],
30
          "isDevPushEnabled": false,
31
          "isProdPushEnabled": true
32
        },
33
        ...
34
      ],
35
      "step": 3 // proceed to step 3
36
    }
37
  }
38
}
Copied!
Step 3 Select the App Id.
Request
Response
1
{
2
  "request":{
3
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
    "application": "XXXXX-XXXXX", // Pushwoosh application code
5
    "device_type": 1,
6
    "ios_key_management_type": "auto",
7
    "step": "3",
8
    "ios_apple_id": "[email protected]",
9
    "ios_apple_password": "xxxxxx",
10
    "ios_framework": "native", // possible values: "native", "cordova", "titanium", "marmalade", "adobeAir", "corona", "xamarin", "phoneGapBuild", "triggerIO", "unity"
11
    "team_id": "12345ABCDE",
12
    "appid": "67890FGHIJ"
13
 }
14
}
Copied!
1
{
2
  "status_code": 200,
3
  "status_message": "OK",
4
  "response": {
5
    "step_data": {
6
      "step": 4 // proceed to step 4
7
    }
8
  }
9
}
Copied!
Step 4 Select the apns_type. Configure the app for Dev or Prod.
Request
Response
1
{
2
  "request":{
3
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
    "application": "XXXXX-XXXXX", // Pushwoosh application code
5
    "device_type": 1,
6
    "ios_key_management_type": "auto",
7
    "step": "4",
8
    "ios_apple_id": "[email protected]",
9
    "ios_apple_password": "xxxxxx",
10
    "ios_framework": "native", // possible values: "native", "cordova", "titanium", "marmalade", "adobeAir", "corona", "xamarin", "phoneGapBuild", "triggerIO", "unity"
11
    "team_id": "12345ABCDE",
12
    "appid": "67890FGHIJ",
13
    "apns_type": "0" // "0" - configure certificate for Development | "1" - configure certificate for Production
14
 }
15
}
Copied!
1
{
2
  "status_code": 200,
3
  "status_message": "OK",
4
  "response": {
5
    "step_data": {
6
      "appIdProfiles":[
7
        {
8
          "profileId":"KLMNOPQRS1",
9
          "name":"iOS Team Provisioning Profile: com.xxxxx.xxxxx"
10
        },
11
        {
12
          "profileId":"KLMNOPQRS2",
13
          "name":"XXXXXXX"
14
        }
15
      ],
16
      "certificates": [
17
        {
18
          "value": "PY986727N9",
19
          "name": "Developer (Expiry Feb 13, 2016)"
20
        }
21
      ],
22
      "step": 5 // proceed to step 5
23
    }
24
  }
25
}
Copied!
Step 5 Select the certificate and provisioning profile.
Request
Response
1
{
2
  "request":{
3
    "auth":"API_ACCESS_TOKEN",
4
    "application":"APPLICATION_CODE",
5
    "device_type":"1",
6
    "ios_key_management_type":"auto",
7
    "step":"5",
8
    "ios_apple_id":"[email protected]",
9
    "ios_apple_password":"xxxxxx",
10
    "ios_framework": "native", // one of native, cordova, titanium, marmalade, adobeAir, corona, xamarin, phoneGapBuild, triggerIO, unity
11
    "team_id":"12345ABCDE",
12
    "appid":"67890FGHIJ",
13
    "apns_type": "0",
14
    "auto_update_profile": "1", // "0" - manual profile update | "1" - auto profile update
15
    "profile": "KLMNOPQRS2",
16
    "certificate" : "PY986727N9"
17
  }
18
}
Copied!
1
{
2
  "status_code": 200,
3
  "status_message": "OK",
4
  "response":{
5
    "providers":{
6
      "ios":true,
7
      "android":false,
8
      "wp7":false,
9
      "macos":false,
10
      "blackberry":false,
11
      "wns":false,
12
      "adm":false,
13
      "safari":false
14
    },
15
    "needTouchProvProfile":true,   // User choosed to auto-update profile
16
    "provProfileTouchedSuccessfully":true, // Profile changed on Apple side
17
    "provProfileUploadSuccessfully":true   // Profile created in Pushwoosh
18
  }
19
}
Copied!
configureApplication for Android
post
https://cp.pushwoosh.com/json/1.3
/configureApplication
/configureApplication for Android
For Private Offering subscriptions only.
Example 
1
{
2
  "request":{
3
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
    "application": "XXXXX-XXXXX", // Pushwoosh application code
5
    "device_type": 3, // 1 - ios, 2 - blackberry, 3 - android, 5 - windows phone, 7 - osx, 8 - windows, 9 - amazon, 10 - safari, 11 - chrome, 14 - email
6
    "android_gcm_api_key": "AIzaSyA…………….7rM", // Android GCM/FCM API Key
7
    "android_gcm_sender_id": "4821……4542", // Android GCM/FCM Sender ID
8
    "android_framework": "native" // see possible values above
9
  }
10
}
11
​
12
​
Copied!
configureApplication for Windows Phone
post
https://cp.pushwoosh.com/json/1.3
/configureApplication
/configureApplication for Windows Phone
For Private Offering subscriptions only.
1
{
2
  "request":{
3
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
    "application": "XXXXX-XXXXX", // Pushwoosh application code
5
    "device_type": 5, // 1 - ios, 2 - blackberry, 3 - android, 5 - windows phone, 7 - osx, 8 - windows, 9 - amazon, 10 - safari, 11 - chrome, 14 - email
6
    "wp7_state": "enabled", // optional. Possible values are "enabled" and "disabled", "disabled" will disable the platform 
7
    "wp7_type": "authenticated", // or "unauthenticated", optional 
8
    "wp7_cert": "iVBORw0KGgoAAAANSUhEUgAABB…", // required when authenticated. Base64-encoded content of certificate file
9
    "wp7_key": "iVBORw0KGgoAAAANSUhEUgAABB…", // required when authenticated. Base64-encoded content of key file
10
    "wp7_ca": "iVBORw0KGgoAAAANSUhEUgAABB…", // required when authenticated. Base64-encoded content of certificate authority file
11
    "wp7_framework": "native" // Possible values: native, phoneGapBuild, marmalade, unity. 
12
  }
13
}
Copied!
configureApplication for Mac OS X
post
https://cp.pushwoosh.com/json/1.3
/configureApplication
/configureApplication for Mac OS X
For Private Offering subscriptions only.
Example
1
{
2
  "request":{
3
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
    "application": "XXXXX-XXXXX", // Pushwoosh application code
5
    "device_type": 7, // 1 - ios, 2 - blackberry, 3 - android, 5 - windows phone, 7 - osx, 8 - windows, 9 - amazon, 10 - safari, 11 - chrome, 14 - email
6
    "macos_key_management_type": "manual", 
7
    "macos_cert_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // optional. Base64-encoded content of Mac OS X certificate file 
8
    "macos_key_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // optional. Base64-encoded content of Mac OS X key file 
9
    "macos_key_password": "PASSWORD", // optional. Key file password 
10
    "macos_gateway": 1 // push gateway. "0" for sandbox or "1" for production 
11
  }
12
}
Copied!
configureApplication for Windows 8
post
https://cp.pushwoosh.com/json/1.3
/configureApplication
/configureApplication for Windows 8
For Private Offering subscriptions only.
Example
1
{
2
  "request":{
3
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
    "application": "XXXXX-XXXXX", // Pushwoosh application code
5
    "device_type": 8, // 1 - ios, 2 - blackberry, 3 - android, 5 - windows phone, 7 - osx, 8 - windows, 9 - amazon, 10 - safari, 11 - chrome, 14 - email
6
    "wns_psid": "ms-app://…", // package security identifier of the app from Windows Store
7
    "wns_secret": "CLIENT_SECRET" // Windows client secret 
8
  }
9
}
10
​
11
​
Copied!
configureApplication for Amazon
post
https://cp.pushwoosh.com/json/1.3
/configureApplication
/configureApplication for Amazon
For Private Offering subscriptions only.
Example
1
{
2
  "request":{
3
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
    "application": "XXXXX-XXXXX", // Pushwoosh application code
5
    "device_type": 9, // 1 - ios, 2 - blackberry, 3 - android, 5 - windows phone, 7 - osx, 8 - windows, 9 - amazon, 10 - safari, 11 - chrome, 14 - email
6
    "adm_cid": "CLIENT_ID", // Amazon client ID
7
    "adm_secret": "CLIENT_SECRET", // Amazon Client Secret  
8
    "adm_framework": "native" // Possible values: native, unity, adobeAir. 
9
  }
10
}
Copied!
configureApplication for Chrome
post
https://cp.pushwoosh.com/json/1.3
/configureApplication
/configureApplication for Chrome
For Private Offering subscriptions only.
Example
1
{
2
  "request":{
3
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
    "application": "XXXXX-XXXXX", // Pushwoosh application code
5
    "device_type": 11, // 1 - ios, 2 - blackberry, 3 - android, 5 - windows phone, 7 - osx, 8 - windows, 9 - amazon, 10 - safari, 11 - chrome, 14 - email
6
    "chrome_gcm_api_key": "AIzaSyA…………….7rM", // GCM/FCM API key for Google Chrome 
7
    "chrome_gcm_project_number": "557…919" // GCM/FCM project number 
8
  }
9
}
Copied!
configureApplication for Safari
post
https://cp.pushwoosh.com/json/1.3
/configureApplication
/configureApplication for Safari
For Private Offering subscriptions only.
Example
1
{
2
  "request":{
3
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
    "application": "XXXXX-XXXXX", // Pushwoosh application code
5
    "device_type": 10, // 1 - ios, 2 - blackberry, 3 - android, 5 - windows phone, 7 - osx, 8 - windows, 9 - amazon, 10 - safari, 11 - chrome, 14 - email
6
    "safari_key_management_type": "manual", 
7
    "safari_website_name": "WEBSITE_NAME", // optional 
8
    "safari_allowed_domains": ["http://site1.com", "https://site2.com"], // optional
9
    "safari_url_template": "https://%@", 
10
    "safari_icon_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // optional. Base64-encoded content of 256x256px png file
11
    "safari_key_file": "MIIMY...BAQ==", // base64-encoded Safari .p12 key file content  
12
    "safari_key_password": "PASSWORD" // optional. Password to the key file above  
13
  }
14
}
15
​
16
​
Copied!
configureApplication for Firefox
post
https://cp.pushwoosh.com/json/1.3
/configureApplication
/configureApplication for Firefox
For Private Offering subscriptions only.
Example
1
{
2
  "request":{
3
    "auth": "lZcoO8ZDvg8nIVh6kS6LWHwcRCS13KxarteY41Alv+a96CKEK+CTUwLszZMbWeuYdTC8KgxphbtAHZ6RQ153",
4
    "application": "1DC69-73EDB",
5
    "device_type": "12",
6
    "firefox_is_enabled": true,
7
    "firefox_fcm_sender_id": "123123123", // optional for fastpushes
8
    "firefox_fcm_api_key" : "sdfsdfsfsddfdsf" // optional for fastpushes
9
  }
10
}
Copied!
configureApplication for Email
post
https://cp.pushwoosh.com/json/1.3
/configureApplication
/configureApplication for Email
For Private Offering subscriptions only.
Example
1
{
2
  "request":{
3
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
    "application": "XXXXX-XXXXX", // Pushwoosh application code
5
    "device_type": 14, // 1 - ios, 2 - blackberry, 3 - android, 5 - windows phone, 7 - osx, 8 - windows, 9 - amazon, 10 - safari, 11 - chrome, 14 - email
6
    "email_from_email": "[email protected]", // email address should be valid and verified
7
    "email_from_name": "SENDER_NAME",  
8
    "email_reply": "[email protected]" // Email address to reply should be valid and verified
9
  }
10
}
Copied!
​
API Reference - Previous
Geozones
Next - API Reference
Email API
Last modified 3mo ago