# API конфигурации приложения

## configureApplication для iOS

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

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


#### Тело запроса

| Название | Тип | Описание |
| -------------------------- | ------- |--------------------------------------------------|
| auth | string | [API access token](/ru/developer/api-reference/api-identifiers/#api-access-token) из Панели управления Pushwoosh |
| application | string | [Код приложения Pushwoosh](/ru/developer/api-reference/api-identifiers/#application-code) |
| device\_type | integer | Должно быть 1 для iOS |
| ios\_key\_management\_type | string | "manual" |
| ios\_key\_file | string | Содержимое файла ключа iOS в кодировке Base64 |
| ios\_key\_password | string | Пароль для файла ключа iOS |
| ios\_gateway | integer | "0" для песочницы (sandbox), "1" для продакшена (production) |
| ios\_framework | string | Возможные значения: "native", "cordova", "titanium" |


<Tabs>
<TabItem label="200">
```json
{
  "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
    }
  }
}
```
</TabItem>
</Tabs>


```json title="Пример"
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",      // обязательно. API access token из Панели управления 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 access token](/ru/developer/api-reference/api-identifiers/#api-access-token) из вашей Панели управления Pushwoosh. |
| application\* | string | [Код приложения Pushwoosh](/ru/developer/api-reference/api-identifiers/#application-code) |
| 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). |

<Tabs>
<TabItem label="200">
```json
{
  "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
    }
  }
}
```
</TabItem>
</Tabs>



<Tabs>
<TabItem label="Пример">
```json
{
  "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"
  }
}

```
</TabItem>
</Tabs>

## configureApplication для Mac OS X

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

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


#### Тело запроса

| Название | Тип | Описание |
| -------------------------------------------------------------- | ------- | --------------------------------------------------- |
| auth\* | string | [API access token](/ru/developer/api-reference/api-identifiers/#api-access-token) из Панели управления Pushwoosh. |
| application\* | string | [Код приложения Pushwoosh](/ru/developer/api-reference/api-identifiers/#application-code) |
| 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). |

<Tabs>
<TabItem label="200">
```json
{
  "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
    }
  }
}
```
</TabItem>
</Tabs>



```json title="Пример"
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",                   // обязательно. API access token из Панели управления 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 access token](/ru/developer/api-reference/api-identifiers/#api-access-token) из Панели управления Pushwoosh. |
| application\* | string | [Код приложения Pushwoosh](/ru/developer/api-reference/api-identifiers/#application-code) |
| device\_type\* | integer | Должно быть 8 для Windows. |
| wns\_psid\* | string | Идентификатор безопасности пакета из Windows Store для приложения. Начинается с "ms-app://". |
| wns\_secret\* | string | Секрет клиента (Client Secret) из Windows Store для приложения. |

<Tabs>
<TabItem label="200">
```json
{
  "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
    }
  }
}
```
</TabItem>
</Tabs>



```json title="Пример"
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // обязательно. API access token из Панели управления 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 access token](/ru/developer/api-reference/api-identifiers/#api-access-token) из Панели управления Pushwoosh. |
| application\* | string | [Код приложения Pushwoosh](/ru/developer/api-reference/api-identifiers/#application-code) |
| device\_type\* | integer | Должно быть 9 для Amazon. |
| adm\_cid\* | string | ID клиента Amazon. |
| adm\_secret\* | string | Секрет клиента Amazon. |
| adm\_framework\* | string | Фреймворк Amazon. Возможные значения: _native, unity, adobeAir._ |

<Tabs>
<TabItem label="200">
```json
{
  "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
    }
  }
}
```
</TabItem>
</Tabs>



```json title="Пример"
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // обязательно. API access token из Панели управления 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 access token](/ru/developer/api-reference/api-identifiers/#api-access-token) из Панели управления Pushwoosh. | Да |
| application* | string | [Код приложения Pushwoosh](/ru/developer/api-reference/api-identifiers/#application-code) | Да |
| 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. | Да |


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



<Tabs>
<TabItem label="Пример">
```json
{
  "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"
  }
}

```
</TabItem>
</Tabs>

## configureApplication для Safari

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

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


#### Тело запроса

| Название | Тип | Описание |
| --------------------------------------------------------------- | ------- |-------------------------------------------------|
| auth\* | string | [API access token](/ru/developer/api-reference/api-identifiers/#api-access-token) из Панели управления Pushwoosh. |
| application\* | string | [Код приложения Pushwoosh](/ru/developer/api-reference/api-identifiers/#application-code) |
| 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 | Пароль к файлу ключа. |

<Tabs>
<TabItem label="200">
```json
{
  "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
    }
  }
}
```
</TabItem>
</Tabs>



```json title="Пример"
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",                    // обязательно. API access token из Панели управления 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 access token](/ru/developer/api-reference/api-identifiers/#api-access-token) из Панели управления Pushwoosh. | Да |
| application* | string | [Код приложения Pushwoosh](/ru/developer/api-reference/api-identifiers/#application-code) | Да |
| 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. | Да |


<Tabs>
<TabItem label="200">
```json
{
  "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
    }
  }
}
```
</TabItem>
</Tabs>



<Tabs>
<TabItem label="Пример">
```json
{
  "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"
  }
}

```
</TabItem>
</Tabs>

## configureApplication для Email

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

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


#### Тело запроса

| Название | Тип | Описание |
| ---------------------------------------------------- | ------- | --------------------------------------------------------- |
| auth\* | string | [API access token](/ru/developer/api-reference/api-identifiers/#api-access-token) из Панели управления Pushwoosh. |
| application\* | string | [Код приложения Pushwoosh](/ru/developer/api-reference/api-identifiers/#application-code) |
| device\_type\* | integer | Должно быть 14 для Email. |
| email\_from\_email\* | string | Email-адрес отправителя. Должен быть действительным и подтвержденным. |
| email\_from\_name\* | string | Имя отправителя. |
| email\_reply\* | string | Email-адрес для ответа. Должен быть действительным и подтвержденным. |

<Tabs>
<TabItem label="200">
```json
{
  "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
    }
  }
}
```
</TabItem>
</Tabs>



```json title="Пример"
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",         // обязательно. API access token из Панели управления 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-адрес для ответа должен быть действительным и подтвержденным
  }
}
```