Перейти к содержанию

Applications API

createApplication

Anchor link to

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

Создает новое приложение в аккаунте.

Тело запроса

Anchor link to
ПараметрТипОписание
authorize_all_tokensbooleanРазрешает всем токенам API взаимодействовать с этим приложением.
auth*stringAPI access token из Pushwoosh Control Panel.
iconstringБинарное содержимое png-файла в кодировке Base64.
sdk_iosstringТип iOS SDK. Возможные значения: “pw” или “corona”. Для Corona пейлоад пуша отличается.
sdk_androidstringТип Android SDK. Возможные значения: “pw”, “corona”, “phonegap”. Пользователи AppPresser выбирают “phonegap”.
title*stringНазвание нового приложения в Pushwoosh.

Пример ответа:

{
"status_code": 200,
"status_message": "OK",
"response": {
"application": "1DC69-73EDB"
}
}

Пример кода:

{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel
"icon": "iVBORw0KGgoAAAANSUhEUgAAA...", // optional. Base-64 encoded binary content of png file
"authorize_all_tokens": true, // optional. If true, allows all api tokens to communicate with this app
"sdk_ios": "pw", // optional. Possible values are "pw" or "corona"
"sdk_android": "pw", // optional. Possible values are "pw", "corona", or "phonegap"
"title": "APP_TITLE" // required. Title for the new app in Pushwoosh
}
}

updateApplication

Anchor link to

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

Обновляет настройки приложения.

Тело запроса

Anchor link to
ПараметрТипОписание
auth*stringAPI access token из Pushwoosh Control Panel.
application*stringPushwoosh application code
iconstringБинарное содержимое png-файла в кодировке Base64.
sdk_iosstringТип iOS SDK. Возможные значения: “pw” или “corona”. Для Corona пейлоад пуша отличается.
sdk_androidstringТип Android SDK. Возможные значения: “pw”, “corona”, “phonegap”. Пользователи AppPresser выбирают “phonegap”.
titlestringНовое название приложения в Pushwoosh.
{
"status_code": 200,
"status_message": "OK",
"response": null
}
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel
"application": "XXXXX-XXXXX", // required. application code of the app you want to update
"icon": "iVBORw0KGgoAAAANSUD6...", // optional. Base-64 encoded binary content of png file
"sdk_ios": "pw", // optional. Possible values are "pw" or "corona"
"sdk_android": "pw", // optional. Possible values are "pw", "corona", or "phonegap"
"title": "APP_TITLE" // optional. New title for the app in Pushwoosh
}
}

deleteApplication

Anchor link to

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

Удаляет приложение из аккаунта.

Тело запроса

Anchor link to
ПараметрТипОписание
auth*stringAPI access token из Pushwoosh Control Panel.
application*stringPushwoosh application code
{
"status_code": 200,
"status_message": "OK",
"response": null
}
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel
"application": "XXXXX-XXXXX" // required. Pushwoosh application code
}
}

getApplication

Anchor link to

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

Возвращает информацию о приложении.

Тело запроса

Anchor link to
ПараметрТипОписание
auth*stringAPI access token из Pushwoosh Control Panel.
application*stringPushwoosh application code
{
"status_code": 200,
"status_message": "OK",
"response": {
"application": {
"adm_cid": "",
"adm_secret": "",
"android_api_type": "x31",
"android_gcm_api_key": "x7836363631366236353566366236353739",
"android_sdk": "x7077",
"icon_url": null,
"ios_gateway": "x783330",
"ios_key_management_type": "x783631373537343666",
"ios_key_password": "x7836353336363236353335333736353333",
"ios_sdk": "x7077",
"title": "0 Application For test",
"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
},
"languages": {
"en": "34",
"zh": "12",
"sv": "7",
"de": "6",
"pt": "6"
}
}
}
}
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // required API access token from Pushwoosh Control Panel
"application": "XXXXX-XXXXX" // required. Pushwoosh application code
}
}

getApplications

Anchor link to

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

Возвращает список приложений аккаунта. Может возвращать результат с пагинацией.

Тело запроса

Anchor link to
ПараметрТипОписание
auth*stringAPI access token из Pushwoosh Control Panel.
pageintegerНомер страницы для пагинации.

Пример запроса

Anchor link to
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel
"page": 2 // optional. The page number for pagination
}
}

Ответ

Anchor link to

Если в аккаунте более 100 приложений, ответ включает current page (текущая страница) и total amount of pages (общее количество страниц).

Пример ответа

Anchor link to
{
"status_code": 200,
"status_message": "OK",
"response": {
"page": 1, // Current page
"total": 2, // Total amount of pages
"applications": [{
"APPLICATION_CODE": "MyApp1"
}, {
"APPLICATION_CODE": "MyApp2"
}]
}
}

getApplicationFile

Anchor link to

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

Возвращает конфигурационные файлы, связанные с приложением.

Тело запроса

Anchor link to
ПараметрТипОписание
auth*stringAPI access token из Pushwoosh Control Panel.
application*stringPushwoosh application code
file*stringИдентификатор файла для получения. См. значения ниже.
{
"status_code": 200,
"status_message": "OK",
"response": null
}
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel
"application": "XXXXX-XXXXX", // required. Pushwoosh application code
"file": "ios_auto_privatekey" // required. identifier of the file to retrieve. See values below
}
}

Возможные значения параметра “file”:

Anchor link to

`“ios_auto_privatekey” | “ios_manual_privatekey” | “ios_auto_certificate” | “ios_manual_certificate” | “ios_push_certificate” | “ios_provisioning_profile” | “macos_manual_privatekey” | “macos_manual_certificate” | “macos_push_certificate” | “safari_manual_privatekey” | “safari_push_certificate” | “safari_push_package” |

Пример ответа:

-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA PRIVATE KEY-----

setApplicationPlatformStatus

Anchor link to

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

Изменяет статус платформы приложения.

Тело запроса

Anchor link to
ПараметрТипОписание
auth*stringAPI access token из Pushwoosh Control Panel.
application*stringPushwoosh application code
platform*integerТип платформы. См. список типов платформ ниже.
status*string”enable” или “disable”
{
"status_code": 200,
"status_message": "OK",
"response": {
"message": "iOS pushes are disabled",
"available_platforms": {
"iOS": false,
"Android": true,
"OS X": false,
"Windows": false,
"Amazon": false,
"Safari": false,
"Chrome": true,
"Firefox": false,
}
}
}
{
"request": {
"application": "XXXXX-XXXXX", // required. Pushwoosh application code
"auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel
"platform": 1, // required. 1 — iOS; 3 — Android; 7 — Mac OS X; 8 — Windows;
// 9 — Amazon; 10 — Safari; 11 — Chrome; 12 — Firefox;
"status": "disable" // required. "disable" or "enable"
}
}