Applications API
createApplication
Anchor link toPOST
https://api.pushwoosh.com/json/1.3/createApplication
สร้างแอปพลิเคชันใหม่บนบัญชี
เนื้อหาของคำขอ (Request Body)
Anchor link toชื่อ | ประเภท | คำอธิบาย |
---|---|---|
authorize_all_tokens | boolean | อนุญาตให้ API token ทั้งหมดสื่อสารกับแอปนี้ได้ |
auth* | string | โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh |
icon | string | เนื้อหาไบนารีของไฟล์ png ที่เข้ารหัสแบบ Base64 |
sdk_ios | string | ประเภทของ iOS SDK ค่าที่เป็นไปได้: “pw” หรือ “corona” สำหรับ Corona, push payload จะแตกต่างกัน |
sdk_android | string | ประเภทของ 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 จากแผงควบคุม Pushwoosh "icon": "iVBORw0KGgoAAAANSUhEUgAAA...", // ไม่จำเป็น เนื้อหาไบนารีของไฟล์ png ที่เข้ารหัสแบบ Base-64 "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 toPOST
https://api.pushwoosh.com/json/1.3/updateApplication
อัปเดตการตั้งค่าแอปพลิเคชัน
เนื้อหาของคำขอ (Request Body)
Anchor link toชื่อ | ประเภท | คำอธิบาย |
---|---|---|
auth* | string | โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh |
application* | string | รหัสแอปพลิเคชัน Pushwoosh |
icon | string | เนื้อหาไบนารีของไฟล์ png ที่เข้ารหัสแบบ Base64 |
sdk_ios | string | ประเภทของ iOS SDK ค่าที่เป็นไปได้: “pw” หรือ “corona” สำหรับ Corona, push payload จะแตกต่างกัน |
sdk_android | string | ประเภทของ Android SDK ค่าที่เป็นไปได้: “pw”, “corona”, “phonegap” ผู้ใช้ AppPresser ให้เลือก “phonegap” |
title | string | ชื่อใหม่สำหรับแอปใน Pushwoosh |
{ "status_code": 200, "status_message": "OK", "response": null}
{ "request": { "auth": "yxoPUlwqm…………pIyEX4H", // จำเป็น โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh "application": "XXXXX-XXXXX", // จำเป็น รหัสแอปพลิเคชันของแอปที่คุณต้องการอัปเดต "icon": "iVBORw0KGgoAAAANSUD6...", // ไม่จำเป็น เนื้อหาไบนารีของไฟล์ png ที่เข้ารหัสแบบ Base-64 "sdk_ios": "pw", // ไม่จำเป็น ค่าที่เป็นไปได้คือ "pw" หรือ "corona" "sdk_android": "pw", // ไม่จำเป็น ค่าที่เป็นไปได้คือ "pw", "corona" หรือ "phonegap" "title": "APP_TITLE" // ไม่จำเป็น ชื่อใหม่สำหรับแอปใน Pushwoosh }}
deleteApplication
Anchor link toPOST
https://api.pushwoosh.com/json/1.3/deleteApplication
ลบแอปออกจากบัญชี
เนื้อหาของคำขอ (Request Body)
Anchor link toชื่อ | ประเภท | คำอธิบาย |
---|---|---|
auth* | string | โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh |
application* | string | รหัสแอปพลิเคชัน Pushwoosh |
{ "status_code": 200, "status_message": "OK", "response": null}
{ "request": { "auth": "yxoPUlwqm…………pIyEX4H", // จำเป็น โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh "application": "XXXXX-XXXXX" // จำเป็น รหัสแอปพลิเคชัน Pushwoosh }}
getApplication
Anchor link toPOST
https://api.pushwoosh.com/json/1.3/getApplication
รับรายละเอียดเกี่ยวกับแอป
เนื้อหาของคำขอ (Request Body)
Anchor link toชื่อ | ประเภท | คำอธิบาย |
---|---|---|
auth* | string | โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh |
application* | string | รหัสแอปพลิเคชัน Pushwoosh |
{ "status_code": 200, "status_message": "OK", "response": { "application": { "adm_cid": "", "adm_secret": "", "android_api_type": "x31", "android_gcm_api_key": "x783636363631366236353566366236353739", "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 จากแผงควบคุม Pushwoosh "application": "XXXXX-XXXXX" // จำเป็น รหัสแอปพลิเคชัน Pushwoosh }}
getApplications
Anchor link toPOST
https://api.pushwoosh.com/json/1.3/getApplications
รับรายการแอปพลิเคชันในบัญชี สามารถคืนผลลัพธ์พร้อมการแบ่งหน้าได้
เนื้อหาของคำขอ (Request Body)
Anchor link toชื่อ | ประเภท | คำอธิบาย |
---|---|---|
auth* | string | โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh |
page | integer | หมายเลขหน้าสำหรับการแบ่งหน้า |
ตัวอย่างคำขอ
Anchor link to{ "request": { "auth": "yxoPUlwqm…………pIyEX4H", // จำเป็น โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh "page": 2 // ไม่จำเป็น หมายเลขหน้าสำหรับการแบ่งหน้า }}
การตอบกลับ (Response)
Anchor link toหากมีแอปพลิเคชันมากกว่า 100 รายการในบัญชี การตอบกลับจะรวมถึง current page
และ total amount of pages
ตัวอย่างการตอบกลับ
Anchor link to{ "status_code": 200, "status_message": "OK", "response": { "page": 1, // หน้าปัจจุบัน "total": 2, // จำนวนหน้าทั้งหมด "applications": [{ "APPLICATION_CODE": "MyApp1" }, { "APPLICATION_CODE": "MyApp2" }] }}
getApplicationFile
Anchor link toPOST
https://api.pushwoosh.com/json/1.3/getApplicationFile
รับไฟล์การกำหนดค่าที่เกี่ยวข้องกับแอป
เนื้อหาของคำขอ (Request Body)
Anchor link toชื่อ | ประเภท | คำอธิบาย |
---|---|---|
auth* | string | โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh |
application* | string | รหัสแอปพลิเคชัน Pushwoosh |
file* | string | ตัวระบุของไฟล์ที่จะดึงข้อมูล ดูค่าด้านล่าง |
{ "status_code": 200, "status_message": "OK", "response": null}
{ "request": { "auth": "yxoPUlwqm…………pIyEX4H", // จำเป็น โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh "application": "XXXXX-XXXXX", // จำเป็น รหัสแอปพลิเคชัน Pushwoosh "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 toPOST
https://api.pushwoosh.com/json/1.3/setApplicationPlatformStatus
เปลี่ยนสถานะของแพลตฟอร์มของแอป
เนื้อหาของคำขอ (Request Body)
Anchor link toชื่อ | ประเภท | คำอธิบาย |
---|---|---|
auth* | string | โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh |
application* | string | รหัสแอปพลิเคชัน Pushwoosh |
platform* | integer | ประเภทของแพลตฟอร์ม ดูรายการประเภทแพลตฟอร์มด้านล่าง |
status* | string | ”enable” หรือ “disable” |
{ "status_code": 200, "status_message": "OK", "response": { "message": "การพุช iOS ถูกปิดใช้งาน", "available_platforms": { "iOS": false, "Android": true, "OS X": false, "Windows": false, "Amazon": false, "Safari": false, "Chrome": true, "Firefox": false } }}
{ "request": { "application": "XXXXX-XXXXX", // จำเป็น รหัสแอปพลิเคชัน Pushwoosh "auth": "yxoPUlwqm…………pIyEX4H", // จำเป็น โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh "platform": 1, // จำเป็น 1 — iOS; 3 — Android; 7 — Mac OS X; 8 — Windows; // 9 — Amazon; 10 — Safari; 11 — Chrome; 12 — Firefox; "status": "disable" // จำเป็น "disable" หรือ "enable" }}