Passer au contenu

API Applications

createApplication

Anchor link to

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

Crée une nouvelle application sur le compte.

Corps de la requête

Anchor link to
NomTypeDescription
authorize_all_tokensbooleanAutorise tous les jetons d’API à communiquer avec cette application.
auth*stringJeton d’accès à l’API depuis le Panneau de Contrôle Pushwoosh.
iconstringContenu binaire d’un fichier png encodé en Base64.
sdk_iosstringType de SDK iOS. Valeurs possibles : « pw » ou « corona ». Pour Corona, la charge utile du push est différente.
sdk_androidstringType de SDK Android. Valeurs possibles : « pw », « corona », « phonegap ». Les utilisateurs d’AppPresser doivent sélectionner « phonegap ».
title*stringTitre de la nouvelle application dans Pushwoosh.

Exemple de réponse :

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

Exemple de code :

{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // requis. Jeton d'accès à l'API depuis le Panneau de Contrôle Pushwoosh
"icon": "iVBORw0KGgoAAAANSUhEUgAAA...", // optionnel. Contenu binaire d'un fichier png encodé en Base64
"authorize_all_tokens": true, // optionnel. Si vrai, autorise tous les jetons d'API à communiquer avec cette application
"sdk_ios": "pw", // optionnel. Les valeurs possibles sont « pw » ou « corona »
"sdk_android": "pw", // optionnel. Les valeurs possibles sont « pw », « corona » ou « phonegap »
"title": "APP_TITLE" // requis. Titre de la nouvelle application dans Pushwoosh
}
}

updateApplication

Anchor link to

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

Met à jour les paramètres de l’application.

Corps de la requête

Anchor link to
NomTypeDescription
auth*stringJeton d’accès à l’API depuis le Panneau de Contrôle Pushwoosh.
application*stringCode d’application Pushwoosh
iconstringContenu binaire d’un fichier png encodé en Base64.
sdk_iosstringType de SDK iOS. Valeurs possibles : « pw » ou « corona ». Pour Corona, la charge utile du push est différente.
sdk_androidstringType de SDK Android. Valeurs possibles : « pw », « corona », « phonegap ». Les utilisateurs d’AppPresser doivent sélectionner « phonegap ».
titlestringNouveau titre pour l’application dans Pushwoosh.
{
"status_code": 200,
"status_message": "OK",
"response": null
}
Exemple
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // requis. Jeton d'accès à l'API depuis le Panneau de Contrôle Pushwoosh
"application": "XXXXX-XXXXX", // requis. Code d'application de l'application que vous souhaitez mettre à jour
"icon": "iVBORw0KGgoAAAANSUD6...", // optionnel. Contenu binaire d'un fichier png encodé en Base64
"sdk_ios": "pw", // optionnel. Les valeurs possibles sont « pw » ou « corona »
"sdk_android": "pw", // optionnel. Les valeurs possibles sont « pw », « corona » ou « phonegap »
"title": "APP_TITLE" // optionnel. Nouveau titre pour l'application dans Pushwoosh
}
}

deleteApplication

Anchor link to

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

Supprime l’application du compte.

Corps de la requête

Anchor link to
NomTypeDescription
auth*stringJeton d’accès à l’API depuis le Panneau de Contrôle Pushwoosh.
application*stringCode d’application Pushwoosh
{
"status_code": 200,
"status_message": "OK",
"response": null
}
Exemple
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // requis. Jeton d'accès à l'API depuis le Panneau de Contrôle Pushwoosh
"application": "XXXXX-XXXXX" // requis. Code d'application Pushwoosh
}
}

getApplication

Anchor link to

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

Obtient les détails de l’application.

Corps de la requête

Anchor link to
NomTypeDescription
auth*stringJeton d’accès à l’API depuis le Panneau de Contrôle Pushwoosh.
application*stringCode d’application Pushwoosh
{
"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", // requis. Jeton d'accès à l'API depuis le Panneau de Contrôle Pushwoosh
"application": "XXXXX-XXXXX" // requis. Code d'application Pushwoosh
}
}

getApplications

Anchor link to

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

Obtient la liste des applications du compte. Peut retourner un résultat avec pagination.

Corps de la requête

Anchor link to
NomTypeDescription
auth*stringJeton d’accès à l’API depuis le Panneau de Contrôle Pushwoosh.
pageintegerLe numéro de page pour la pagination.

Exemple de requête

Anchor link to
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // requis. Jeton d'accès à l'API depuis le Panneau de Contrôle Pushwoosh
"page": 2 // optionnel. Le numéro de page pour la pagination
}
}

S’il y a plus de 100 applications dans le compte, la réponse inclut current page et total amount of pages.

Exemple de réponse

Anchor link to
{
"status_code": 200,
"status_message": "OK",
"response": {
"page": 1, // Page actuelle
"total": 2, // Nombre total de pages
"applications": [{
"APPLICATION_CODE": "MyApp1"
}, {
"APPLICATION_CODE": "MyApp2"
}]
}
}

getApplicationFile

Anchor link to

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

Obtient les fichiers de configuration liés à l’application.

Corps de la requête

Anchor link to
NomTypeDescription
auth*stringJeton d’accès à l’API depuis le Panneau de Contrôle Pushwoosh.
application*stringCode d’application Pushwoosh
file*stringIdentifiant du fichier à récupérer. Voir les valeurs ci-dessous.
{
"status_code": 200,
"status_message": "OK",
"response": null
}
Exemple
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // requis. Jeton d'accès à l'API depuis le Panneau de Contrôle Pushwoosh
"application": "XXXXX-XXXXX", // requis. Code d'application Pushwoosh
"file": "ios_auto_privatekey" // requis. Identifiant du fichier à récupérer. Voir les valeurs ci-dessous
}
}

Valeurs possibles pour le paramètre « 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” |

Exemple de réponse :

-----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

Change le statut de la plateforme de l’application.

Corps de la requête

Anchor link to
NomTypeDescription
auth*stringJeton d’accès à l’API depuis le Panneau de Contrôle Pushwoosh.
application*stringCode d’application Pushwoosh
platform*integerLe type de plateforme. Voir la liste des types de plateforme ci-dessous.
status*string« enable » ou « 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,
}
}
}
Exemple
{
"request": {
"application": "XXXXX-XXXXX", // requis. Code d'application Pushwoosh
"auth": "yxoPUlwqm…………pIyEX4H", // requis. Jeton d'accès à l'API depuis le Panneau de Contrôle Pushwoosh
"platform": 1, // requis. 1 — iOS ; 3 — Android ; 7 — Mac OS X ; 8 — Windows ;
// 9 — Amazon ; 10 — Safari ; 11 — Chrome ; 12 — Firefox ;
"status": "disable" // requis. « disable » ou « enable »
}
}