Zum Inhalt springen
BenutzerhandbücherSupport Demo anfordern Anmelden
Pushwoosh.com

App-Konfigurations-API

configureApplication für iOS

Anchor link to

Konfiguriert die iOS-Plattform für die App.

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

Request Body

Anchor link to
NameTypBeschreibung
authstringAPI-Zugriffstoken aus dem Pushwoosh Control Panel
applicationstringPushwoosh-Anwendungscode
device_typeintegerMuss 1 für iOS sein
ios_key_management_typestring”manual”
ios_key_filestringBase64-kodierter Inhalt der iOS-Schlüsseldatei
ios_key_passwordstringPasswort für die iOS-Schlüsseldatei
ios_gatewayinteger”0” für Sandbox, “1” für Produktion
ios_frameworkstringMögliche Werte: “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
    }
  }
}
Beispiel
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",      // erforderlich. API-Zugriffstoken aus dem Pushwoosh Control Panel
    "application": "XXXXX-XXXXX",        // erforderlich. Pushwoosh-Anwendungscode
    "device_type": 1,                    // erforderlich. 1 für iOS
    "ios_key_management_type": "manual", // erforderlich. "manual"
    "ios_key_file": "MIIMY...BAQ==",     // erforderlich. Base64-kodierter Inhalt der iOS-Schlüsseldatei
    "ios_key_password": "password",      // erforderlich.
    "ios_gateway": 1,                    // erforderlich. "0" (Sandbox) | "1" (Produktion)
    "ios_framework": "native"            // erforderlich. mögliche Werte: "native", "cordova", "titanium",
                                         //           "marmalade", "adobeAir", "corona", "xamarin",
                                         //           "phoneGapBuild", "triggerIO", "unity"
  }
}

configureApplication für Android

Anchor link to

Konfiguriert die Android-Plattform für die App.

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

Request Body

Anchor link to
NameTypBeschreibung
auth*stringAPI-Zugriffstoken aus Ihrem Pushwoosh Control Panel.
application*stringPushwoosh-Anwendungscode
device_type*integerMuss 3 für Android sein.
android_framework*stringAndroid-Framework. Mögliche Werte: native, cordova, marmalade, adobeAir, corona, xamarin, phoneGapBuild, triggerIO, titanium, unity.
android_fcm_service_account*objectFCM-Dienstkontoschlüssel (JSON-Datei, die in den Firebase-Projekteinstellungen generiert wird).
{
  "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 für Mac OS X

Anchor link to

Konfiguriert die Mac OS X-Plattform für die App.

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

Request Body

Anchor link to
NameTypBeschreibung
auth*stringAPI-Zugriffstoken aus dem Pushwoosh Control Panel.
application*stringPushwoosh-Anwendungscode
device_type*integerMuss 7 für Mac OS X sein.
macos_key_management_type*stringDerzeit ist nur der Typ “manual” verfügbar.
macos_cert_filestringBase64-kodierter Inhalt der Mac OS X-Zertifikatsdatei.
macos_key_filestringBase64-kodierter Inhalt der Mac OS X-Schlüsseldatei.
macos_key_passwordstringPasswort der Schlüsseldatei.
macos_gateway*integerPush-Gateway. “0” für Sandbox, “1” für Produktion.
{
  "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
    }
  }
}
Beispiel
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",                   // erforderlich. API-Zugriffstoken aus dem Pushwoosh Control Panel
    "application": "XXXXX-XXXXX",                     // erforderlich. Pushwoosh-Anwendungscode
    "device_type": 7,                                 // erforderlich. 7 für Mac OS X
    "macos_key_management_type": "manual",            // erforderlich. "manual"
    "macos_cert_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // optional. Base64-kodierter Inhalt der Mac OS X-Zertifikatsdatei
    "macos_key_file": "iVBORw0KGgoAAAANSUhEUgAABB…",  // optional. Base64-kodierter Inhalt der Mac OS X-Schlüsseldatei
    "macos_key_password": "PASSWORD",                 // optional. Passwort der Schlüsseldatei
    "macos_gateway": 1                                // erforderlich. Push-Gateway. "0" für Sandbox oder "1" für Produktion
  }
}

configureApplication für Windows

Anchor link to

Konfiguriert Windows-Plattformen für die App.

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

Request Body

Anchor link to
NameTypBeschreibung
auth*stringAPI-Zugriffstoken aus dem Pushwoosh Control Panel.
application*stringPushwoosh-Anwendungscode
device_type*integerMuss 8 für Windows sein.
wns_psid*stringPaketsicherheitskennung aus dem Windows Store für die App. Beginnt mit “ms-app://“.
wns_secret*stringClient Secret aus dem Windows Store für die App.
{
  "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
    }
  }
}
Beispiel
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // erforderlich. API-Zugriffstoken aus dem Pushwoosh Control Panel
    "application": "XXXXX-XXXXX",    // erforderlich. Pushwoosh-Anwendungscode
    "device_type": 8,                // erforderlich. 8 für Windows
    "wns_psid": "ms-app://…",        // erforderlich. Paketsicherheitskennung der App aus dem Windows Store
    "wns_secret": "CLIENT_SECRET"    // erforderlich. Windows Client Secret
  }
}

configureApplication für Amazon

Anchor link to

Konfiguriert die Amazon-Plattform für die App.

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

Request Body

Anchor link to
NameTypBeschreibung
auth*stringAPI-Zugriffstoken aus dem Pushwoosh Control Panel.
application*stringPushwoosh-Anwendungscode
device_type*integerMuss 9 für Amazon sein.
adm_cid*stringAmazon Client-ID.
adm_secret*stringAmazon Client Secret.
adm_framework*stringAmazon-Framework. Mögliche Werte: 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
    }
  }
}
Beispiel
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // erforderlich. API-Zugriffstoken aus dem Pushwoosh Control Panel
    "application": "XXXXX-XXXXX",    // erforderlich. Pushwoosh-Anwendungscode
    "device_type": 9,                // erforderlich. 9 für Amazon
    "adm_cid": "CLIENT_ID",          // erforderlich. Amazon Client-ID
    "adm_secret": "CLIENT_SECRET",   // erforderlich. Amazon Client Secret
    "adm_framework": "native"        // erforderlich. mögliche Werte: native, unity, adobeAir.
  }
}

configureApplication für Chrome

Anchor link to

Konfiguriert die Chrome-Plattform für die App.

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

Request Body

Anchor link to
NameTypBeschreibungErforderlich
auth*stringAPI-Zugriffstoken aus dem Pushwoosh Control Panel.Erforderlich
application*stringPushwoosh-AnwendungscodeErforderlich
device_type*integerMuss 11 für Chrome sein.Erforderlich
chrome_fcm_service_account*objectFCM-Dienstkontoschlüssel (JSON-Datei, die in den Firebase-Projekteinstellungen generiert wird).Erforderlich
chrome_vapid_key*stringÖffentlicher VAPID-Schlüssel (Voluntary Application Server Identification), der für die Authentifizierung von Push-Benachrichtigungen in Chrome verwendet wird.Erforderlich
chrome_vapid_private_key*stringPrivater VAPID-Schlüssel, der zum Signieren und Senden von Push-Benachrichtigungen in Chrome verwendet wird.Erforderlich
{
  "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 für Safari

Anchor link to

Konfiguriert die Safari-Plattform für die App.

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

Request Body

Anchor link to
NameTypBeschreibung
auth*stringAPI-Zugriffstoken aus dem Pushwoosh Control Panel.
application*stringPushwoosh-Anwendungscode
device_type*integerMuss 10 für Safari sein.
safari_key_management_type*stringDerzeit ist nur der Typ “manual” verfügbar.
safari_website_namestringName der Website.
safari_allowed_domainsarrayBsp.: https://site1.com”, https://site2.com”
safari_url_template*stringSafari-URL-Vorlage, formatiert als “https://%@“.
safari_icon_filestringBase64-kodierter Inhalt einer 256x256px PNG-Datei.
safari_key_file*stringBase64-kodierter Inhalt der Safari .p12-Schlüsseldatei.
safari_key_passwordstringPasswort für die Schlüsseldatei.
{
  "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
    }
  }
}
Beispiel
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",                    // erforderlich. API-Zugriffstoken aus dem Pushwoosh Control Panel
    "application": "XXXXX-XXXXX",                      // erforderlich. Pushwoosh-Anwendungscode
    "device_type": 10,                                 // erforderlich. 10 für Safari
    "safari_key_management_type": "manual",            // erforderlich. "manual"
    "safari_website_name": "WEBSITE_NAME",             // optional.
    "safari_allowed_domains": [                        // optional.
      "https://site1.com",
      "https://site2.com"
    ],
    "safari_url_template": "https://%@",               // erforderlich.
    "safari_icon_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // optional. Base64-kodierter Inhalt einer 256x256px PNG-Datei
    "safari_key_file": "MIIMY...BAQ==",                // erforderlich. Base64-kodierter Inhalt der Safari .p12-Schlüsseldatei
    "safari_key_password": "PASSWORD"                  // optional. Passwort für die obige Schlüsseldatei
  }
}

configureApplication für Firefox

Anchor link to

Konfiguriert die Firefox-Plattform für die App.

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

Request Body

Anchor link to
NameTypBeschreibungErforderlich
auth*stringAPI-Zugriffstoken aus dem Pushwoosh Control Panel.Erforderlich
application*stringPushwoosh-AnwendungscodeErforderlich
device_type*integerMuss 12 für Firefox sein.Erforderlich
firefox_is_enabledbooleanAktiviert Push-Benachrichtigungen für Firefox.Optional
firefox_fcm_service_account*objectJSON, das in den Firebase-Projekteinstellungen generiert wird.Erforderlich
firefox_vapid_key*stringÖffentlicher VAPID-Schlüssel (Voluntary Application Server Identification), der für die Authentifizierung von Push-Benachrichtigungen in Firefox verwendet wird.Erforderlich
firefox_vapid_private_key*stringPrivater VAPID-Schlüssel, der zum Signieren und Senden von Push-Benachrichtigungen in Firefox verwendet wird.Erforderlich
{
  "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 für E-Mail

Anchor link to

Konfiguriert die E-Mail-Plattform für die App.

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

Request Body

Anchor link to
NameTypBeschreibung
auth*stringAPI-Zugriffstoken aus dem Pushwoosh Control Panel.
application*stringPushwoosh-Anwendungscode
device_type*integerMuss 14 für E-Mail sein.
email_from_email*stringE-Mail-Adresse des Absenders. Sollte gültig und verifiziert sein.
email_from_name*stringName des Absenders.
email_reply*stringE-Mail-Adresse für Antworten. Sollte gültig und verifiziert sein.
{
  "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
    }
  }
}
Beispiel
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",         // erforderlich. API-Zugriffstoken aus dem Pushwoosh Control Panel
    "application": "XXXXX-XXXXX",           // erforderlich. Pushwoosh-Anwendungscode
    "device_type": 14,                      // erforderlich. 14 für E-Mail
    "email_from_email": "email@domain.com", // erforderlich. Die E-Mail-Adresse sollte gültig und verifiziert sein
    "email_from_name": "SENDER_NAME",       // erforderlich. Name, der im "Von"-Feld der E-Mail angezeigt wird
    "email_reply": "email@domain.com"       // erforderlich. Die E-Mail-Adresse für Antworten sollte gültig und verifiziert sein
  }
}