API de configuration d'application

configureApplication pour iOS

Configure la plateforme iOS pour l’application.

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

Corps de la requête

Nom	Type	Description
auth	string	Jeton d’accès à l’API depuis le Panneau de Contrôle Pushwoosh
application	string	Code d’application Pushwoosh
device_type	integer	Doit être 1 pour iOS
ios_key_management_type	string	”manual”
ios_key_file	string	Contenu du fichier de clé iOS encodé en Base64
ios_key_password	string	Mot de passe pour le fichier de clé iOS
ios_gateway	string	”0” pour le sandbox, “1” pour la production
ios_framework	string	Valeurs possibles : “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",      // requis. Jeton d'accès à l'API depuis le Panneau de Contrôle Pushwoosh
    "application": "XXXXX-XXXXX",        // requis. Code d'application Pushwoosh
    "device_type": 1,                    // requis. 1 pour iOS
    "ios_key_management_type": "manual", // requis. "manual"
    "ios_key_file": "MIIMY...BAQ==",     // requis. contenu du fichier de clé iOS encodé en Base64
    "ios_key_password": "password",      // requis.
    "ios_gateway": "1",                  // requis. "0" (sandbox) | "1" (production)
    "ios_framework": "native"            // requis. valeurs possibles : "native", "cordova", "titanium",
                                         //           "marmalade", "adobeAir", "corona", "xamarin",
                                         //           "phoneGapBuild", "triggerIO", "unity"
  }
}

configureApplication pour Android

Configure la plateforme Android pour l’application.

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

Corps de la requête

Nom	Type	Description
auth*	string	Jeton d’accès à l’API depuis votre Panneau de Contrôle Pushwoosh.
application*	string	Code d’application Pushwoosh
device_type*	integer	Doit être 3 pour Android.
android_framework*	string	Framework Android. Valeurs possibles : native, cordova, marmalade, adobeAir, corona, xamarin, phoneGapBuild, triggerIO, titanium, unity.
android_fcm_service_account*	object	Clé de compte de service FCM (fichier JSON généré dans les paramètres du projet 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
    }
  }
}

Exemple

{
  "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 pour Mac OS X

Configure la plateforme Mac OS X pour l’application.

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

Corps de la requête

Nom	Type	Description
auth*	string	Jeton d’accès à l’API depuis le Panneau de Contrôle Pushwoosh.
application*	string	Code d’application Pushwoosh
device_type*	integer	Doit être 7 pour Mac OS X.
macos_key_management_type*	string	Seul le type “manual” est actuellement disponible.
macos_cert_file	string	Contenu du fichier de certificat Mac OS X encodé en Base64.
macos_key_file	string	Contenu du fichier de clé Mac OS X encodé en Base64.
macos_key_password	string	Mot de passe du fichier de clé.
macos_gateway*	integer	Passerelle de push. “0” pour le sandbox, “1” pour la 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",                   // requis. Jeton d'accès à l'API depuis le Panneau de Contrôle Pushwoosh
    "application": "XXXXX-XXXXX",                     // requis. Code d'application Pushwoosh
    "device_type": 7,                                 // requis. 7 pour Mac OS X
    "macos_key_management_type": "manual",            // requis. "manual"
    "macos_cert_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // optionnel. Contenu du fichier de certificat Mac OS X encodé en Base64
    "macos_key_file": "iVBORw0KGgoAAAANSUhEUgAABB…",  // optionnel. Contenu du fichier de clé Mac OS X encodé en Base64
    "macos_key_password": "PASSWORD",                 // optionnel. Mot de passe du fichier de clé
    "macos_gateway": 1                                // requis. passerelle de push. "0" pour le sandbox ou "1" pour la production
  }
}

configureApplication pour Windows

Configure les plateformes Windows pour l’application.

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

Corps de la requête

Nom	Type	Description
auth*	string	Jeton d’accès à l’API depuis le Panneau de Contrôle Pushwoosh.
application*	string	Code d’application Pushwoosh
device_type*	integer	Doit être 8 pour Windows.
wns_psid*	string	Identifiant de sécurité du package depuis le Windows Store pour l’application. Commence par “ms-app://“.
wns_secret*	string	Secret client depuis le Windows Store pour l’application.

{
  "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",  // requis. Jeton d'accès à l'API depuis le Panneau de Contrôle Pushwoosh
    "application": "XXXXX-XXXXX",    // requis. Code d'application Pushwoosh
    "device_type": 8,                // requis. 8 pour Windows
    "wns_psid": "ms-app://…",        // requis. identifiant de sécurité du package de l'application depuis le Windows Store
    "wns_secret": "CLIENT_SECRET"    // requis. Secret client Windows
  }
}

configureApplication pour Amazon

Configure la plateforme Amazon pour l’application.

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

Corps de la requête

Nom	Type	Description
auth*	string	Jeton d’accès à l’API depuis le Panneau de Contrôle Pushwoosh.
application*	string	Code d’application Pushwoosh
device_type*	integer	Doit être 9 pour Amazon.
adm_cid*	string	ID client Amazon.
adm_secret*	string	Secret client Amazon.
adm_framework*	string	Framework Amazon. Valeurs possibles : 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",  // requis. Jeton d'accès à l'API depuis le Panneau de Contrôle Pushwoosh
    "application": "XXXXX-XXXXX",    // requis. Code d'application Pushwoosh
    "device_type": 9,                // requis. 9 pour Amazon
    "adm_cid": "CLIENT_ID",          // requis. ID client Amazon
    "adm_secret": "CLIENT_SECRET",   // requis. Secret client Amazon
    "adm_framework": "native"        // requis. valeurs possibles : native, unity, adobeAir.
  }
}

configureApplication pour Chrome

Configure la plateforme Chrome pour l’application.

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

Corps de la requête

Nom	Type	Description	Requis
auth*	string	Jeton d’accès à l’API depuis le Panneau de Contrôle Pushwoosh.	Requis
application*	string	Code d’application Pushwoosh	Requis
device_type*	integer	Doit être 11 pour Chrome.	Requis
chrome_fcm_service_account*	object	Clé de compte de service FCM (fichier JSON généré dans les paramètres du projet Firebase).	Requis
chrome_vapid_key*	string	Clé VAPID (Voluntary Application Server Identification) publique utilisée pour l’authentification des notifications push dans Chrome.	Requis
chrome_vapid_private_key*	string	Clé VAPID privée utilisée pour signer et envoyer les notifications push dans Chrome.	Requis

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

Exemple

{
  "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 pour Safari

Configure la plateforme Safari pour l’application.

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

Corps de la requête

Nom	Type	Description
auth*	string	Jeton d’accès à l’API depuis le Panneau de Contrôle Pushwoosh.
application*	string	Code d’application Pushwoosh
device_type*	integer	Doit être 10 pour Safari.
safari_key_management_type*	string	Seul le type “manual” est actuellement disponible.
safari_website_name	string	Nom du site web.
safari_allowed_domains	array	Ex : https://site1.com”, https://site2.com”
safari_url_template*	string	Modèle d’URL Safari formaté comme “https://%@“.
safari_icon_file	string	Contenu encodé en Base64 d’un fichier png de 256x256px.
safari_key_file*	string	Contenu du fichier de clé .p12 de Safari encodé en Base64.
safari_key_password	string	Mot de passe pour le fichier de clé.

{
  "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",                    // requis. Jeton d'accès à l'API depuis le Panneau de Contrôle Pushwoosh
    "application": "XXXXX-XXXXX",                      // requis. Code d'application Pushwoosh
    "device_type": 10,                                 // requis. 10 pour Safari
    "safari_key_management_type": "manual",            // requis. "manual"
    "safari_website_name": "WEBSITE_NAME",             // optionnel.
    "safari_allowed_domains": [                        // optionnel.
      "https://site1.com",
      "https://site2.com"
    ],
    "safari_url_template": "https://%@",               // requis.
    "safari_icon_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // optionnel. Contenu encodé en Base64 d'un fichier png de 256x256px
    "safari_key_file": "MIIMY...BAQ==",                // requis. contenu du fichier de clé .p12 de Safari encodé en Base64
    "safari_key_password": "PASSWORD"                  // optionnel. Mot de passe pour le fichier de clé ci-dessus
  }
}

configureApplication pour Firefox

Configure la plateforme Firefox pour l’application.

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

Corps de la requête

Nom	Type	Description	Requis
auth*	string	Jeton d’accès à l’API depuis le Panneau de Contrôle Pushwoosh.	Requis
application*	string	Code d’application Pushwoosh	Requis
device_type*	integer	Doit être 12 pour Firefox.	Requis
firefox_is_enabled	boolean	Active les notifications push pour Firefox.	Optionnel
firefox_fcm_service_account*	object	JSON généré dans les paramètres du projet Firebase.	Requis
firefox_vapid_key*	string	Clé VAPID (Voluntary Application Server Identification) publique utilisée pour l’authentification des notifications push dans Firefox.	Requis
firefox_vapid_private_key*	string	Clé VAPID privée utilisée pour signer et envoyer les notifications push dans Firefox.	Requis

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

Exemple

{
  "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 pour l’e-mail

Configure la plateforme d’e-mail pour l’application.

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

Corps de la requête

Nom	Type	Description
auth*	string	Jeton d’accès à l’API depuis le Panneau de Contrôle Pushwoosh.
application*	string	Code d’application Pushwoosh
device_type*	integer	Doit être 14 pour l’e-mail.
email_from_email*	string	Adresse e-mail de l’expéditeur. Doit être valide et vérifiée.
email_from_name*	string	Nom de l’expéditeur.
email_reply*	string	Adresse e-mail de réponse. Doit être valide et vérifiée.

{
  "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",         // requis. Jeton d'accès à l'API depuis le Panneau de Contrôle Pushwoosh
    "application": "XXXXX-XXXXX",           // requis. Code d'application Pushwoosh
    "device_type": 14,                      // requis. 14 pour l'e-mail
    "email_from_email": "email@domain.com", // requis. L'adresse e-mail doit être valide et vérifiée
    "email_from_name": "SENDER_NAME",       // requis. Nom à afficher dans le champ "De" de l'e-mail
    "email_reply": "email@domain.com"       // requis. L'adresse e-mail de réponse doit être valide et vérifiée
  }
}