ข้ามไปยังเนื้อหา

Applications API

createApplication

Anchor link to

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

สร้าง application ใหม่ในบัญชี

Request Body

Anchor link to
NameTypeDescription
authorize_all_tokensbooleanอนุญาตให้ API token ทั้งหมดสื่อสารกับแอปนี้ได้
auth*stringAPI access token จาก Pushwoosh Control Panel
iconstringเนื้อหาไบนารีที่เข้ารหัส Base64 ของไฟล์ png
sdk_iosstringประเภท iOS SDK ค่าที่เป็นไปได้: “pw” หรือ “corona” สำหรับ Corona payload ของ push จะแตกต่างออกไป
sdk_androidstringประเภท Android SDK ค่าที่เป็นไปได้: “pw”, “corona”, “phonegap” ผู้ใช้ AppPresser ให้เลือก “phonegap”
title*stringชื่อสำหรับแอปใหม่ใน Pushwoosh

ตัวอย่างการตอบกลับ:

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

ตัวอย่างโค้ด:

{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // จำเป็น API access token จาก Pushwoosh Control Panel
"icon": "iVBORw0KGgoAAAANSUhEUgAAA...", // ไม่บังคับ เนื้อหาไบนารีที่เข้ารหัส Base-64 ของไฟล์ png
"authorize_all_tokens": true, // ไม่บังคับ หากเป็น true จะอนุญาตให้ api token ทั้งหมดสื่อสารกับแอปนี้ได้
"sdk_ios": "pw", // ไม่บังคับ ค่าที่เป็นไปได้คือ "pw" หรือ "corona"
"sdk_android": "pw", // ไม่บังคับ ค่าที่เป็นไปได้คือ "pw", "corona" หรือ "phonegap"
"title": "APP_TITLE" // จำเป็น ชื่อสำหรับแอปใหม่ใน Pushwoosh
}
}

updateApplication

Anchor link to

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

อัปเดตการตั้งค่า application

Request Body

Anchor link to
NameTypeDescription
auth*stringAPI access token จาก Pushwoosh Control Panel
application*stringรหัส Pushwoosh application
iconstringเนื้อหาไบนารีที่เข้ารหัส Base64 ของไฟล์ png
sdk_iosstringประเภท iOS SDK ค่าที่เป็นไปได้: “pw” หรือ “corona” สำหรับ Corona payload ของ push จะแตกต่างออกไป
sdk_androidstringประเภท Android SDK ค่าที่เป็นไปได้: “pw”, “corona”, “phonegap” ผู้ใช้ AppPresser ให้เลือก “phonegap”
titlestringชื่อใหม่สำหรับแอปใน Pushwoosh
{
"status_code": 200,
"status_message": "OK",
"response": null
}
Example
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // จำเป็น API access token จาก Pushwoosh Control Panel
"application": "XXXXX-XXXXX", // จำเป็น รหัส application ของแอปที่คุณต้องการอัปเดต
"icon": "iVBORw0KGgoAAAANSUD6...", // ไม่บังคับ เนื้อหาไบนารีที่เข้ารหัส Base-64 ของไฟล์ png
"sdk_ios": "pw", // ไม่บังคับ ค่าที่เป็นไปได้คือ "pw" หรือ "corona"
"sdk_android": "pw", // ไม่บังคับ ค่าที่เป็นไปได้คือ "pw", "corona" หรือ "phonegap"
"title": "APP_TITLE" // ไม่บังคับ ชื่อใหม่สำหรับแอปใน Pushwoosh
}
}

deleteApplication

Anchor link to

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

ลบแอปออกจากบัญชี

Request Body

Anchor link to
NameTypeDescription
auth*stringAPI access token จาก Pushwoosh Control Panel
application*stringรหัส Pushwoosh application
{
"status_code": 200,
"status_message": "OK",
"response": null
}
Example
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // จำเป็น API access token จาก Pushwoosh Control Panel
"application": "XXXXX-XXXXX" // จำเป็น รหัส Pushwoosh application
}
}

getApplication

Anchor link to

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

รับรายละเอียดเกี่ยวกับแอป

Request Body

Anchor link to
NameTypeDescription
auth*stringAPI access token จาก Pushwoosh Control Panel
application*stringรหัส Pushwoosh application
{
"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", // จำเป็น API access token จาก Pushwoosh Control Panel
"application": "XXXXX-XXXXX" // จำเป็น รหัส Pushwoosh application
}
}

getApplications

Anchor link to

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

รับรายการ application ในบัญชี สามารถส่งคืนผลลัพธ์พร้อมการแบ่งหน้า (pagination)

Request Body

Anchor link to
NameTypeDescription
auth*stringAPI access token จาก Pushwoosh Control Panel
pageintegerหมายเลขหน้าสำหรับการแบ่งหน้า (pagination)

Example request

Anchor link to
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // จำเป็น API access token จาก Pushwoosh Control Panel
"page": 2 // ไม่บังคับ หมายเลขหน้าสำหรับการแบ่งหน้า
}
}

หากมี application มากกว่า 100 รายการในบัญชี การตอบกลับจะรวม current page และ total amount of pages

Example Response

Anchor link to
{
"status_code": 200,
"status_message": "OK",
"response": {
"page": 1, // หน้าปัจจุบัน
"total": 2, // จำนวนหน้าทั้งหมด
"applications": [{
"APPLICATION_CODE": "MyApp1"
}, {
"APPLICATION_CODE": "MyApp2"
}]
}
}

getApplicationFile

Anchor link to

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

รับไฟล์การกำหนดค่าที่เกี่ยวข้องกับแอป

Request Body

Anchor link to
NameTypeDescription
auth*stringAPI access token จาก Pushwoosh Control Panel
application*stringรหัส Pushwoosh application
file*stringตัวระบุ (identifier) ของไฟล์ที่จะดึงข้อมูล ดูค่าด้านล่าง
{
"status_code": 200,
"status_message": "OK",
"response": null
}
Example
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // จำเป็น API access token จาก Pushwoosh Control Panel
"application": "XXXXX-XXXXX", // จำเป็น รหัส Pushwoosh application
"file": "ios_auto_privatekey" // จำเป็น ตัวระบุของไฟล์ที่จะดึงข้อมูล ดูค่าด้านล่าง
}
}

ค่าที่เป็นไปได้สำหรับพารามิเตอร์ “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” |

ตัวอย่างการตอบกลับ:

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

เปลี่ยนสถานะแพลตฟอร์มของแอป

Request Body

Anchor link to
NameTypeDescription
auth*stringAPI access token จาก Pushwoosh Control Panel
application*stringรหัส Pushwoosh application
platform*integerประเภทแพลตฟอร์ม ดูรายการประเภทแพลตฟอร์มด้านล่าง
status*string”enable” หรือ “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,
}
}
}
Example
{
"request": {
"application": "XXXXX-XXXXX", // จำเป็น รหัส Pushwoosh application
"auth": "yxoPUlwqm…………pIyEX4H", // จำเป็น API access token จาก Pushwoosh Control Panel
"platform": 1, // จำเป็น 1 — iOS; 3 — Android; 7 — Mac OS X; 8 — Windows;
// 9 — Amazon; 10 — Safari; 11 — Chrome; 12 — Firefox;
"status": "disable" // จำเป็น "disable" หรือ "enable"
}
}