API для настройки приложения

configureApplication для iOS

Настраивает платформу iOS для приложения.

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

Тело запроса

Имя	Тип	Описание
auth	string	Токен доступа API из Панели управления Pushwoosh
application	string	Код приложения Pushwoosh
device_type	integer	Должен быть 1 для iOS
ios_key_management_type	string	”manual”
ios_key_file	string	Содержимое файла ключа iOS в кодировке Base64
ios_key_password	string	Пароль для файла ключа iOS
ios_gateway	string	”0” для песочницы (sandbox), “1” для рабочей среды (production)
ios_framework	string	Возможные значения: “native”, “cordova”, “titanium”

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "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
    }
  }
}

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",      // обязательно. Токен доступа API из Панели управления Pushwoosh
    "application": "XXXXX-XXXXX",        // обязательно. Код приложения Pushwoosh
    "device_type": 1,                    // обязательно. 1 для iOS
    "ios_key_management_type": "manual", // обязательно. "manual"
    "ios_key_file": "MIIMY...BAQ==",     // обязательно. Содержимое файла ключа iOS в кодировке base64
    "ios_key_password": "password",      // обязательно.
    "ios_gateway": "1",                  // обязательно. "0" (песочница) | "1" (рабочая среда)
    "ios_framework": "native"            // обязательно. возможные значения: "native", "cordova", "titanium",
                                         //           "marmalade", "adobeAir", "corona", "xamarin",
                                         //           "phoneGapBuild", "triggerIO", "unity"
  }
}

configureApplication для Android

Настраивает платформу Android для приложения.

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

Тело запроса

Имя	Тип	Описание
auth*	string	Токен доступа API из вашей Панели управления Pushwoosh.
application*	string	Код приложения Pushwoosh
device_type*	integer	Должен быть 3 для Android.
android_framework*	string	Фреймворк Android. Возможные значения: native, cordova, marmalade, adobeAir, corona, xamarin, phoneGapBuild, triggerIO, titanium, unity.
android_fcm_service_account*	object	Ключ сервисного аккаунта FCM (JSON-файл, сгенерированный в настройках проекта Firebase).

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

Пример

{
  "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"
  }
}

configureApplication для Mac OS X

Настраивает платформу Mac OS X для приложения.

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

Тело запроса

Имя	Тип	Описание
auth*	string	Токен доступа API из Панели управления Pushwoosh.
application*	string	Код приложения Pushwoosh
device_type*	integer	Должен быть 7 для Mac OS X.
macos_key_management_type*	string	В настоящее время доступен только тип “manual”.
macos_cert_file	string	Содержимое файла сертификата Mac OS X в кодировке Base64.
macos_key_file	string	Содержимое файла ключа Mac OS X в кодировке Base64.
macos_key_password	string	Пароль для файла ключа.
macos_gateway*	integer	Push-шлюз. “0” для песочницы (sandbox), “1” для рабочей среды (production).

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "amazon": false,
      "android": false,
      "baidu_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",                   // обязательно. Токен доступа API из Панели управления Pushwoosh
    "application": "XXXXX-XXXXX",                     // обязательно. Код приложения Pushwoosh
    "device_type": 7,                                 // обязательно. 7 для Mac OS X
    "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                                // обязательно. push-шлюз. "0" для песочницы или "1" для рабочей среды
  }
}

configureApplication для Windows

Настраивает платформы Windows для приложения.

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

Тело запроса

Имя	Тип	Описание
auth*	string	Токен доступа API из Панели управления Pushwoosh.
application*	string	Код приложения Pushwoosh
device_type*	integer	Должен быть 8 для Windows.
wns_psid*	string	Идентификатор безопасности пакета из Windows Store для приложения. Начинается с “ms-app://“.
wns_secret*	string	Секрет клиента (Client Secret) из Windows Store для приложения.

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

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // обязательно. Токен доступа API из Панели управления Pushwoosh
    "application": "XXXXX-XXXXX",    // обязательно. Код приложения Pushwoosh
    "device_type": 8,                // обязательно. 8 для Windows
    "wns_psid": "ms-app://…",        // обязательно. идентификатор безопасности пакета приложения из Windows Store
    "wns_secret": "CLIENT_SECRET"    // обязательно. секрет клиента Windows
  }
}

configureApplication для Amazon

Настраивает платформу Amazon для приложения.

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

Тело запроса

Имя	Тип	Описание
auth*	string	Токен доступа API из Панели управления Pushwoosh.
application*	string	Код приложения Pushwoosh
device_type*	integer	Должен быть 9 для Amazon.
adm_cid*	string	ID клиента 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,
      "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
    }
  }
}

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // обязательно. Токен доступа API из Панели управления Pushwoosh
    "application": "XXXXX-XXXXX",    // обязательно. Код приложения Pushwoosh
    "device_type": 9,                // обязательно. 9 для Amazon
    "adm_cid": "CLIENT_ID",          // обязательно. ID клиента Amazon
    "adm_secret": "CLIENT_SECRET",   // обязательно. Секрет клиента Amazon
    "adm_framework": "native"        // обязательно. возможные значения: native, unity, adobeAir.
  }
}

configureApplication для Chrome

Настраивает платформу Chrome для приложения.

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

Тело запроса

Имя	Тип	Описание	Обязательно
auth*	string	Токен доступа API из Панели управления Pushwoosh.	Обязательно
application*	string	Код приложения Pushwoosh	Обязательно
device_type*	integer	Должен быть 11 для Chrome.	Обязательно
chrome_fcm_service_account*	object	Ключ сервисного аккаунта FCM (JSON-файл, сгенерированный в настройках проекта Firebase).	Обязательно
chrome_vapid_key*	string	Публичный ключ VAPID (Voluntary Application Server Identification), используемый для аутентификации push-уведомлений в Chrome.	Обязательно
chrome_vapid_private_key*	string	Приватный ключ VAPID, используемый для подписи и отправки push-уведомлений в Chrome.	Обязательно

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

configureApplication для Safari

Настраивает платформу Safari для приложения.

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

Тело запроса

Имя	Тип	Описание
auth*	string	Токен доступа API из Панели управления Pushwoosh.
application*	string	Код приложения Pushwoosh
device_type*	integer	Должен быть 10 для Safari.
safari_key_management_type*	string	В настоящее время доступен только тип “manual”.
safari_website_name	string	Название веб-сайта.
safari_allowed_domains	array	Пример: https://site1.com”, https://site2.com”
safari_url_template*	string	Шаблон URL для Safari в формате “https://%@“.
safari_icon_file	string	Содержимое png-файла размером 256x256px в кодировке Base64.
safari_key_file*	string	Содержимое файла ключа Safari .p12 в кодировке Base64.
safari_key_password	string	Пароль к файлу ключа.

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "amazon": false,
      "android": false,
      "baidu_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",                    // обязательно. Токен доступа API из Панели управления Pushwoosh
    "application": "XXXXX-XXXXX",                      // обязательно. Код приложения Pushwoosh
    "device_type": 10,                                 // обязательно. 10 для Safari
    "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…", // опционально. Содержимое png-файла размером 256x256px в кодировке Base64
    "safari_key_file": "MIIMY...BAQ==",                // обязательно. Содержимое файла ключа Safari .p12 в кодировке base64
    "safari_key_password": "PASSWORD"                  // опционально. Пароль к файлу ключа, указанному выше
  }
}

configureApplication для Firefox

Настраивает платформу Firefox для приложения.

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

Тело запроса

Имя	Тип	Описание	Обязательно
auth*	string	Токен доступа API из Панели управления Pushwoosh.	Обязательно
application*	string	Код приложения Pushwoosh	Обязательно
device_type*	integer	Должен быть 12 для Firefox.	Обязательно
firefox_is_enabled	boolean	Включает push-уведомления для Firefox.	Опционально
firefox_fcm_service_account*	object	JSON, сгенерированный в настройках проекта Firebase.	Обязательно
firefox_vapid_key*	string	Публичный ключ VAPID (Voluntary Application Server Identification), используемый для аутентификации push-уведомлений в Firefox.	Обязательно
firefox_vapid_private_key*	string	Приватный ключ VAPID, используемый для подписи и отправки push-уведомлений в Firefox.	Обязательно

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

configureApplication для Email

Настраивает платформу Email для приложения.

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

Тело запроса

Имя	Тип	Описание
auth*	string	Токен доступа API из Панели управления Pushwoosh.
application*	string	Код приложения Pushwoosh
device_type*	integer	Должен быть 14 для Email.
email_from_email*	string	Email-адрес отправителя. Должен быть действительным и подтвержденным.
email_from_name*	string	Имя отправителя.
email_reply*	string	Email-адрес для ответа. Должен быть действительным и подтвержденным.

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "amazon": false,
      "android": false,
      "baidu_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",         // обязательно. Токен доступа API из Панели управления Pushwoosh
    "application": "XXXXX-XXXXX",           // обязательно. Код приложения Pushwoosh
    "device_type": 14,                      // обязательно. 14 для email
    "email_from_email": "email@domain.com", // обязательно. Email-адрес должен быть действительным и подтвержденным
    "email_from_name": "SENDER_NAME",       // обязательно. Имя для отображения в поле "От"
    "email_reply": "email@domain.com"       // обязательно. Email-адрес для ответа должен быть действительным и подтвержденным
  }
}