콘텐츠로 건너뛰기

앱 구성 API

iOS용 configureApplication

Anchor link to

앱의 iOS 플랫폼을 구성합니다.

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

요청 본문

Anchor link to
이름유형설명
authstringPushwoosh 제어판의 API 액세스 토큰
applicationstringPushwoosh 애플리케이션 코드
device_typeintegeriOS의 경우 1이어야 합니다
ios_key_management_typestring”manual”
ios_key_filestringBase64로 인코딩된 iOS 키 파일 콘텐츠
ios_key_passwordstringiOS 키 파일의 비밀번호
ios_gatewayinteger샌드박스는 “0”, 프로덕션은 “1”
ios_frameworkstring가능한 값: “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", // 필수. Pushwoosh 제어판의 API 액세스 토큰
"application": "XXXXX-XXXXX", // 필수. Pushwoosh 애플리케이션 코드
"device_type": 1, // 필수. iOS의 경우 1
"ios_key_management_type": "manual", // 필수. "manual"
"ios_key_file": "MIIMY...BAQ==", // 필수. base64로 인코딩된 iOS 키 파일 콘텐츠
"ios_key_password": "password", // 필수.
"ios_gateway": 1, // 필수. "0" (샌드박스) | "1" (프로덕션)
"ios_framework": "native" // 필수. 가능한 값: "native", "cordova", "titanium",
// "marmalade", "adobeAir", "corona", "xamarin",
// "phoneGapBuild", "triggerIO", "unity"
}
}

Android용 configureApplication

Anchor link to

앱의 Android 플랫폼을 구성합니다.

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

요청 본문

Anchor link to
이름유형설명
auth*stringPushwoosh 제어판의 API 액세스 토큰입니다.
application*stringPushwoosh 애플리케이션 코드
device_type*integerAndroid의 경우 3이어야 합니다.
android_framework*stringAndroid 프레임워크. 가능한 값: native, cordova, marmalade, adobeAir, corona, xamarin, phoneGapBuild, triggerIO, titanium, unity.
android_fcm_service_account*objectFCM 서비스 계정 키 (Firebase 프로젝트 설정에서 생성된 JSON 파일).
{
"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"
}
}

Mac OS X용 configureApplication

Anchor link to

앱의 Mac OS X 플랫폼을 구성합니다.

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

요청 본문

Anchor link to
이름유형설명
auth*stringPushwoosh 제어판의 API 액세스 토큰입니다.
application*stringPushwoosh 애플리케이션 코드
device_type*integerMac OS X의 경우 7이어야 합니다.
macos_key_management_type*string현재 “manual” 유형만 사용할 수 있습니다.
macos_cert_filestringBase64로 인코딩된 Mac OS X 인증서 파일 콘텐츠입니다.
macos_key_filestringBase64로 인코딩된 Mac OS X 키 파일 콘텐츠입니다.
macos_key_passwordstring키 파일 비밀번호입니다.
macos_gateway*integer푸시 게이트웨이. 샌드박스는 “0”, 프로덕션은 “1”입니다.
{
"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", // 필수. Pushwoosh 제어판의 API 액세스 토큰
"application": "XXXXX-XXXXX", // 필수. Pushwoosh 애플리케이션 코드
"device_type": 7, // 필수. Mac OS X의 경우 7
"macos_key_management_type": "manual", // 필수. "manual"
"macos_cert_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // 선택 사항. Base64로 인코딩된 Mac OS X 인증서 파일의 콘텐츠
"macos_key_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // 선택 사항. Base64로 인코딩된 Mac OS X 키 파일의 콘텐츠
"macos_key_password": "PASSWORD", // 선택 사항. 키 파일 비밀번호
"macos_gateway": 1 // 필수. 푸시 게이트웨이. 샌드박스는 "0", 프로덕션은 "1"
}
}

Windows용 configureApplication

Anchor link to

앱의 Windows 플랫폼을 구성합니다.

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

요청 본문

Anchor link to
이름유형설명
auth*stringPushwoosh 제어판의 API 액세스 토큰입니다.
application*stringPushwoosh 애플리케이션 코드
device_type*integerWindows의 경우 8이어야 합니다.
wns_psid*string앱의 Windows Store에서 가져온 패키지 보안 식별자입니다. “ms-app://“로 시작합니다.
wns_secret*string앱의 Windows Store에서 가져온 클라이언트 시크릿입니다.
{
"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", // 필수. Pushwoosh 제어판의 API 액세스 토큰
"application": "XXXXX-XXXXX", // 필수. Pushwoosh 애플리케이션 코드
"device_type": 8, // 필수. Windows의 경우 8
"wns_psid": "ms-app://…", // 필수. Windows Store에서 가져온 앱의 패키지 보안 식별자
"wns_secret": "CLIENT_SECRET" // 필수. Windows 클라이언트 시크릿
}
}

Amazon용 configureApplication

Anchor link to

앱의 Amazon 플랫폼을 구성합니다.

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

요청 본문

Anchor link to
이름유형설명
auth*stringPushwoosh 제어판의 API 액세스 토큰입니다.
application*stringPushwoosh 애플리케이션 코드
device_type*integerAmazon의 경우 9여야 합니다.
adm_cid*stringAmazon 클라이언트 ID입니다.
adm_secret*stringAmazon 클라이언트 시크릿입니다.
adm_framework*stringAmazon 프레임워크. 가능한 값: 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", // 필수. Pushwoosh 제어판의 API 액세스 토큰
"application": "XXXXX-XXXXX", // 필수. Pushwoosh 애플리케이션 코드
"device_type": 9, // 필수. Amazon의 경우 9
"adm_cid": "CLIENT_ID", // 필수. Amazon 클라이언트 ID
"adm_secret": "CLIENT_SECRET", // 필수. Amazon 클라이언트 시크릿
"adm_framework": "native" // 필수. 가능한 값: native, unity, adobeAir.
}
}

Chrome용 configureApplication

Anchor link to

앱의 Chrome 플랫폼을 구성합니다.

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

요청 본문

Anchor link to
이름유형설명필수
auth*stringPushwoosh 제어판의 API 액세스 토큰입니다.필수
application*stringPushwoosh 애플리케이션 코드필수
device_type*integerChrome의 경우 11이어야 합니다.필수
chrome_fcm_service_account*objectFCM 서비스 계정 키 (Firebase 프로젝트 설정에서 생성된 JSON 파일).필수
chrome_vapid_key*stringChrome에서 푸시 알림 인증에 사용되는 공개 VAPID (Voluntary Application Server Identification) 키입니다.필수
chrome_vapid_private_key*stringChrome에서 푸시 알림을 서명하고 보내는 데 사용되는 비공개 VAPID 키입니다.필수
{
"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"
}
}

Safari용 configureApplication

Anchor link to

앱의 Safari 플랫폼을 구성합니다.

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

요청 본문

Anchor link to
이름유형설명
auth*stringPushwoosh 제어판의 API 액세스 토큰입니다.
application*stringPushwoosh 애플리케이션 코드
device_type*integerSafari의 경우 10이어야 합니다.
safari_key_management_type*string현재 “manual” 유형만 사용할 수 있습니다.
safari_website_namestring웹사이트 이름입니다.
safari_allowed_domainsarray예: https://site1.com”, https://site2.com
safari_url_template*string”https://%@” 형식의 Safari URL 템플릿입니다.
safari_icon_filestringBase64로 인코딩된 256x256px png 파일의 콘텐츠입니다.
safari_key_file*stringBase64로 인코딩된 Safari .p12 키 파일 콘텐츠입니다.
safari_key_passwordstring키 파일의 비밀번호입니다.
{
"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", // 필수. Pushwoosh 제어판의 API 액세스 토큰
"application": "XXXXX-XXXXX", // 필수. Pushwoosh 애플리케이션 코드
"device_type": 10, // 필수. Safari의 경우 10
"safari_key_management_type": "manual", // 필수. "manual"
"safari_website_name": "WEBSITE_NAME", // 선택 사항.
"safari_allowed_domains": [ // 선택 사항.
"https://site1.com",
"https://site2.com"
],
"safari_url_template": "https://%@", // 필수.
"safari_icon_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // 선택 사항. Base64로 인코딩된 256x256px png 파일의 콘텐츠
"safari_key_file": "MIIMY...BAQ==", // 필수. base64로 인코딩된 Safari .p12 키 파일 콘텐츠
"safari_key_password": "PASSWORD" // 선택 사항. 위 키 파일의 비밀번호
}
}

Firefox용 configureApplication

Anchor link to

앱의 Firefox 플랫폼을 구성합니다.

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

요청 본문

Anchor link to
이름유형설명필수
auth*stringPushwoosh 제어판의 API 액세스 토큰입니다.필수
application*stringPushwoosh 애플리케이션 코드필수
device_type*integerFirefox의 경우 12여야 합니다.필수
firefox_is_enabledbooleanFirefox에 대한 푸시 알림을 활성화합니다.선택 사항
firefox_fcm_service_account*objectFirebase 프로젝트 설정에서 생성된 JSON입니다.필수
firefox_vapid_key*stringFirefox에서 푸시 알림 인증에 사용되는 공개 VAPID (Voluntary Application Server Identification) 키입니다.필수
firefox_vapid_private_key*stringFirefox에서 푸시 알림을 서명하고 보내는 데 사용되는 비공개 VAPID 키입니다.필수
{
"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"
}
}

Email용 configureApplication

Anchor link to

앱의 Email 플랫폼을 구성합니다.

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

요청 본문

Anchor link to
이름유형설명
auth*stringPushwoosh 제어판의 API 액세스 토큰입니다.
application*stringPushwoosh 애플리케이션 코드
device_type*integerEmail의 경우 14여야 합니다.
email_from_email*string보내는 사람 이메일 주소입니다. 유효하고 확인된 주소여야 합니다.
email_from_name*string보내는 사람 이름입니다.
email_reply*string회신할 이메일 주소입니다. 유효하고 확인된 주소여야 합니다.
{
"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", // 필수. Pushwoosh 제어판의 API 액세스 토큰
"application": "XXXXX-XXXXX", // 필수. Pushwoosh 애플리케이션 코드
"device_type": 14, // 필수. 이메일의 경우 14
"email_from_email": "email@domain.com", // 필수. 이메일 주소는 유효하고 확인되어야 합니다
"email_from_name": "SENDER_NAME", // 필수. "보낸 사람" 이메일 필드에 표시할 이름
"email_reply": "email@domain.com" // 필수. 회신할 이메일 주소는 유효하고 확인되어야 합니다
}
}