Pular para o conteúdo
Guias do usuárioSuporte Solicitar demonstração Entrar
Pushwoosh.com

API de configuração de aplicativo

configureApplication para iOS

Anchor link to

Configura a plataforma iOS para o aplicativo.

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

Corpo da Requisição

Anchor link to
NomeTipoDescrição
authstringToken de acesso à API do Painel de Controle da Pushwoosh
applicationstringCódigo do aplicativo Pushwoosh
device_typeintegerDeve ser 1 para iOS
ios_key_management_typestring”manual”
ios_key_filestringConteúdo do arquivo de chave do iOS codificado em Base64
ios_key_passwordstringSenha para o arquivo de chave do iOS
ios_gatewayinteger”0” para sandbox, “1” para produção
ios_frameworkstringValores possíveis: “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
    }
  }
}
Exemplo
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",      // obrigatório. Token de acesso à API do Painel de Controle da Pushwoosh
    "application": "XXXXX-XXXXX",        // obrigatório. Código do aplicativo Pushwoosh
    "device_type": 1,                    // obrigatório. 1 para iOS
    "ios_key_management_type": "manual", // obrigatório. "manual"
    "ios_key_file": "MIIMY...BAQ==",     // obrigatório. conteúdo do arquivo de chave do iOS codificado em base64
    "ios_key_password": "password",      // obrigatório.
    "ios_gateway": 1,                    // obrigatório. "0" (sandbox) | "1" (produção)
    "ios_framework": "native"            // obrigatório. valores possíveis: "native", "cordova", "titanium",
                                         //           "marmalade", "adobeAir", "corona", "xamarin",
                                         //           "phoneGapBuild", "triggerIO", "unity"
  }
}

configureApplication para Android

Anchor link to

Configura a plataforma Android para o aplicativo.

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

Corpo da Requisição

Anchor link to
NomeTipoDescrição
auth*stringToken de acesso à API do seu Painel de Controle da Pushwoosh.
application*stringCódigo do aplicativo Pushwoosh
device_type*integerDeve ser 3 para Android.
android_framework*stringFramework Android. Valores possíveis: native, cordova, marmalade, adobeAir, corona, xamarin, phoneGapBuild, triggerIO, titanium, unity.
android_fcm_service_account*objectChave da conta de serviço do FCM (arquivo JSON gerado nas configurações do projeto 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
    }
  }
}
 
{
  "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 para Mac OS X

Anchor link to

Configura a plataforma Mac OS X para o aplicativo.

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

Corpo da Requisição

Anchor link to
NomeTipoDescrição
auth*stringToken de acesso à API do Painel de Controle da Pushwoosh.
application*stringCódigo do aplicativo Pushwoosh
device_type*integerDeve ser 7 para Mac OS X.
macos_key_management_type*stringApenas o tipo “manual” está disponível no momento.
macos_cert_filestringConteúdo do arquivo de certificado do Mac OS X codificado em Base64.
macos_key_filestringConteúdo do arquivo de chave do Mac OS X codificado em Base64.
macos_key_passwordstringSenha do arquivo de chave.
macos_gateway*integerGateway de push. “0” para sandbox, “1” para produção.
{
  "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
    }
  }
}
Exemplo
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",                   // obrigatório. Token de acesso à API do Painel de Controle da Pushwoosh
    "application": "XXXXX-XXXXX",                     // obrigatório. Código do aplicativo Pushwoosh
    "device_type": 7,                                 // obrigatório. 7 para Mac OS X
    "macos_key_management_type": "manual",            // obrigatório. "manual"
    "macos_cert_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // opcional. Conteúdo codificado em Base64 do arquivo de certificado do Mac OS X
    "macos_key_file": "iVBORw0KGgoAAAANSUhEUgAABB…",  // opcional. Conteúdo codificado em Base64 do arquivo de chave do Mac OS X
    "macos_key_password": "PASSWORD",                 // opcional. Senha do arquivo de chave
    "macos_gateway": 1                                // obrigatório. gateway de push. "0" para sandbox ou "1" para produção
  }
}

configureApplication para Windows

Anchor link to

Configura as plataformas Windows para o aplicativo.

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

Corpo da Requisição

Anchor link to
NomeTipoDescrição
auth*stringToken de acesso à API do Painel de Controle da Pushwoosh.
application*stringCódigo do aplicativo Pushwoosh
device_type*integerDeve ser 8 para Windows.
wns_psid*stringIdentificador de segurança do pacote da Windows Store para o aplicativo. Começa com “ms-app://“.
wns_secret*stringSegredo do Cliente da Windows Store para o aplicativo.
{
  "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
    }
  }
}
Exemplo
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // obrigatório. Token de acesso à API do Painel de Controle da Pushwoosh
    "application": "XXXXX-XXXXX",    // obrigatório. Código do aplicativo Pushwoosh
    "device_type": 8,                // obrigatório. 8 para Windows
    "wns_psid": "ms-app://…",        // obrigatório. identificador de segurança do pacote do aplicativo da Windows Store
    "wns_secret": "CLIENT_SECRET"    // obrigatório. Segredo do cliente Windows
  }
}

configureApplication para Amazon

Anchor link to

Configura a plataforma Amazon para o aplicativo.

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

Corpo da Requisição

Anchor link to
NomeTipoDescrição
auth*stringToken de acesso à API do Painel de Controle da Pushwoosh.
application*stringCódigo do aplicativo Pushwoosh
device_type*integerDeve ser 9 para Amazon.
adm_cid*stringID do cliente Amazon.
adm_secret*stringSegredo do cliente Amazon.
adm_framework*stringFramework Amazon. Valores possíveis: 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
    }
  }
}
Exemplo
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // obrigatório. Token de acesso à API do Painel de Controle da Pushwoosh
    "application": "XXXXX-XXXXX",    // obrigatório. Código do aplicativo Pushwoosh
    "device_type": 9,                // obrigatório. 9 para Amazon
    "adm_cid": "CLIENT_ID",          // obrigatório. ID do cliente Amazon
    "adm_secret": "CLIENT_SECRET",   // obrigatório. Segredo do Cliente Amazon
    "adm_framework": "native"        // obrigatório. valores possíveis: native, unity, adobeAir.
  }
}

configureApplication para Chrome

Anchor link to

Configura a plataforma Chrome para o aplicativo.

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

Corpo da Requisição

Anchor link to
NomeTipoDescriçãoObrigatório
auth*stringToken de acesso à API do Painel de Controle da Pushwoosh.Obrigatório
application*stringCódigo do aplicativo PushwooshObrigatório
device_type*integerDeve ser 11 para Chrome.Obrigatório
chrome_fcm_service_account*objectChave da conta de serviço do FCM (arquivo JSON gerado nas configurações do projeto Firebase).Obrigatório
chrome_vapid_key*stringChave VAPID pública (Voluntary Application Server Identification) usada para autenticação de notificação push no Chrome.Obrigatório
chrome_vapid_private_key*stringChave VAPID privada usada para assinar e enviar notificações push no Chrome.Obrigatório
{
  "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 para Safari

Anchor link to

Configura a plataforma Safari para o aplicativo.

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

Corpo da Requisição

Anchor link to
NomeTipoDescrição
auth*stringToken de acesso à API do Painel de Controle da Pushwoosh.
application*stringCódigo do aplicativo Pushwoosh
device_type*integerDeve ser 10 para Safari.
safari_key_management_type*stringApenas o tipo “manual” está disponível no momento.
safari_website_namestringNome do site.
safari_allowed_domainsarrayEx: https://site1.com”, https://site2.com”
safari_url_template*stringModelo de URL do Safari formatado como “https://%@“.
safari_icon_filestringConteúdo codificado em Base64 de um arquivo png de 256x256px.
safari_key_file*stringConteúdo do arquivo de chave .p12 do Safari codificado em Base64.
safari_key_passwordstringSenha para o arquivo de chave.
{
  "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
    }
  }
}
Exemplo
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",                    // obrigatório. Token de acesso à API do Painel de Controle da Pushwoosh
    "application": "XXXXX-XXXXX",                      // obrigatório. Código do aplicativo Pushwoosh
    "device_type": 10,                                 // obrigatório. 10 para Safari
    "safari_key_management_type": "manual",            // obrigatório. "manual"
    "safari_website_name": "WEBSITE_NAME",             // opcional.
    "safari_allowed_domains": [                        // opcional.
      "https://site1.com",
      "https://site2.com"
    ],
    "safari_url_template": "https://%@",               // obrigatório.
    "safari_icon_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // opcional. Conteúdo codificado em Base64 de um arquivo png de 256x256px
    "safari_key_file": "MIIMY...BAQ==",                // obrigatório. conteúdo do arquivo de chave .p12 do Safari codificado em base64
    "safari_key_password": "PASSWORD"                  // opcional. Senha para o arquivo de chave acima
  }
}

configureApplication para Firefox

Anchor link to

Configura a plataforma Firefox para o aplicativo.

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

Corpo da Requisição

Anchor link to
NomeTipoDescriçãoObrigatório
auth*stringToken de acesso à API do Painel de Controle da Pushwoosh.Obrigatório
application*stringCódigo do aplicativo PushwooshObrigatório
device_type*integerDeve ser 12 para Firefox.Obrigatório
firefox_is_enabledbooleanHabilita notificações push para o Firefox.Opcional
firefox_fcm_service_account*objectJSON gerado nas configurações do projeto Firebase.Obrigatório
firefox_vapid_key*stringChave VAPID pública (Voluntary Application Server Identification) usada para autenticação de notificação push no Firefox.Obrigatório
firefox_vapid_private_key*stringChave VAPID privada usada para assinar e enviar notificações push no Firefox.Obrigatório
{
  "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 para E-mail

Anchor link to

Configura a plataforma de E-mail para o aplicativo.

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

Corpo da Requisição

Anchor link to
NomeTipoDescrição
auth*stringToken de acesso à API do Painel de Controle da Pushwoosh.
application*stringCódigo do aplicativo Pushwoosh
device_type*integerDeve ser 14 para E-mail.
email_from_email*stringEndereço de e-mail do remetente. Deve ser válido e verificado.
email_from_name*stringNome do remetente.
email_reply*stringEndereço de e-mail para resposta. Deve ser válido e verificado.
{
  "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
    }
  }
}
Exemplo
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",         // obrigatório. Token de acesso à API do Painel de Controle da Pushwoosh
    "application": "XXXXX-XXXXX",           // obrigatório. Código do aplicativo Pushwoosh
    "device_type": 14,                      // obrigatório. 14 para e-mail
    "email_from_email": "email@domain.com", // obrigatório. O endereço de e-mail deve ser válido e verificado
    "email_from_name": "SENDER_NAME",       // obrigatório. Nome a ser exibido no campo "De" do e-mail
    "email_reply": "email@domain.com"       // obrigatório. O endereço de e-mail para resposta deve ser válido e verificado
  }
}