ภาพรวม Pushwoosh API
Pushwoosh API ช่วยให้นักพัฒนาสามารถโต้ตอบกับแพลตฟอร์ม Pushwoosh ได้
คุณสามารถทำอะไรได้บ้างกับ Pushwoosh API
Anchor link toด้วย Pushwoosh API คุณจะสามารถเข้าถึงไลบรารีที่กว้างขวางซึ่งมีเมธอดมากกว่า 100 เมธอดที่ช่วยให้คุณสามารถ:
- ส่งการแจ้งเตือนแบบพุชส่วนบุคคล
- สร้าง นำเข้า ส่งออก และจัดการเซกเมนต์ผู้ใช้เพื่อการกำหนดเป้าหมายที่แม่นยำ
- ใช้ Bulk API เพื่อจัดการผู้ใช้/อุปกรณ์เป็นชุด
- กำหนดค่าแอปพลิเคชัน
- ติดตามอีเวนต์ของผู้ใช้และเพิ่มแท็กให้กับผู้ใช้เพื่อเพิ่มประสิทธิภาพการกำหนดเป้าหมายและการปรับให้เป็นส่วนบุคคล
- สร้างและจัดการ Pushwoosh Entities เช่น พรีเซ็ต แท็ก อีเวนต์ แอปพลิเคชัน ฯลฯ
- เริ่มต้น Pushwoosh Customer Journeys ผ่าน API
- ดึงข้อมูลสถิติที่ครอบคลุมเกี่ยวกับ Customer Journeys และแคมเปญ Push/Email/SMS
- ใช้ Geofencing เพื่อส่งการแจ้งเตือนตามตำแหน่งเมื่อผู้ใช้เข้าหรือออกจากพื้นที่ทางภูมิศาสตร์ที่ระบุ
- ผสานรวมบริการของบุคคลที่สามกับ Pushwoosh ได้อย่างราบรื่น
หากต้องการสำรวจเมธอดที่มีอยู่ทั้งหมดและค้นพบความสามารถที่กว้างขวางของ Pushwoosh API โปรดดูที่ ดัชนีอ้างอิงเมธอด API
การรับรองความถูกต้อง
Anchor link toPushwoosh API ใช้โทเค็น API เพื่อรับรองความถูกต้องของคำขอ โทเค็นมีสองประเภท: เซิร์ฟเวอร์ และ อุปกรณ์ ซึ่งแต่ละประเภทใช้สำหรับขอบเขต API ที่เฉพาะเจาะจง
แต่ละบัญชี Pushwoosh จะมาพร้อมกับโทเค็นการเข้าถึง API เริ่มต้นที่สร้างขึ้นสำหรับ Pushwoosh Demo App คุณสามารถดู สร้าง และจัดการโทเค็น API ของคุณได้ใน Pushwoosh Control Panel
ขีดจำกัดอัตรา (Rate limits)
Anchor link toขีดจำกัดอัตราคือจำนวนคำขอที่ API สามารถรับได้ในช่วงเวลาที่กำหนด แม้ว่าคำขอ API ส่วนใหญ่ใน Pushwoosh จะไม่จำกัด แต่คำขอ API ของ /createMessage จะถูกจำกัดไว้ที่ 600 คำขอต่อนาทีเพื่อรับประกันคุณภาพการบริการสำหรับผู้ใช้ทุกคน
คำขอ (Requests)
Anchor link toต้องใช้ HTTPS สำหรับคำขอ API ทั้งหมดเพื่อรับประกันการถ่ายโอนข้อมูลที่ปลอดภัย
การตอบกลับ (Responses)
Anchor link toโดยทั่วไป Pushwoosh API จะส่งคืนการตอบกลับในรูปแบบ JSON
รหัสความสำเร็จและข้อผิดพลาด
Anchor link toรหัสความสำเร็จ
Anchor link toเมื่อคำขอ API ของคุณได้รับการประมวลผลสำเร็จ คุณจะได้รับรหัสความสำเร็จเป็นส่วนหนึ่งของการตอบกลับ
| รหัสสถานะ HTTP | ข้อความสถานะ | คำอธิบาย |
|---|---|---|
| 200 | OK | Pushwoosh ประมวลผลคำขอสำเร็จ |
โปรดทราบว่าเมื่อคุณได้รับการตอบกลับ HTTP 200 หมายความว่าคำขอของคุณได้รับการทำความเข้าใจและประมวลผลสำเร็จ แต่ไม่ได้รับประกันความสำเร็จของการกระทำนั้นๆ ดังนั้นโปรดตรวจสอบข้อความแสดงข้อผิดพลาดหรือคำเตือน (การเข้าถึงถูกปฏิเสธ, ไม่พบแอปพลิเคชัน, คีย์ API ไม่ถูกต้อง ฯลฯ) เพื่อพิจารณาความสำเร็จของการกระทำ
| รหัสสถานะ | ข้อความสถานะ |
|---|---|
| 200 | Warnings: You have reached the subscriber limit. Push Message will be sent to 1 random device only (คำเตือน: คุณมีจำนวนผู้ติดตามถึงขีดจำกัดแล้ว ข้อความพุชจะถูกส่งไปยังอุปกรณ์สุ่มเพียง 1 เครื่องเท่านั้น) |
| 200 | Warnings: You have exceeded the number of active devices allowed on your current subscription plan. (คำเตือน: คุณมีจำนวนอุปกรณ์ที่ใช้งานเกินกว่าที่อนุญาตในแผนการสมัครสมาชิกปัจจุบันของคุณ) |
| 210 | Access denied or application not found (การเข้าถึงถูกปฏิเสธหรือไม่พบแอปพลิเคชัน) |
| 210 | Application not found (ไม่พบแอปพลิเคชัน) |
| 210 | Application suspended (แอปพลิเคชันถูกระงับ) |
| 210 | Account not found (ไม่พบบัญชี) |
| 210 | Account has been suspended (บัญชีถูกระงับ) |
| 210 | Suspended account can not use device filtration (บัญชีที่ถูกระงับไม่สามารถใช้การกรองอุปกรณ์ได้) |
| 210 | API token or application is not set (โทเค็น API หรือแอปพลิเคชันไม่ได้ตั้งค่า) |
| 210 | Please select at least one platform (โปรดเลือกอย่างน้อยหนึ่งแพลตฟอร์ม) |
| 210 | Invalid API Token: Account not found (โทเค็น API ไม่ถูกต้อง: ไม่พบบัญชี) |
| 210 | No application or group code given (ไม่ได้ให้รหัสแอปพลิเคชันหรือกลุ่ม) |
| 210 | API token or application or account is not set (โทเค็น API หรือแอปพลิเคชันหรือบัญชีไม่ได้ตั้งค่า) |
รหัสข้อผิดพลาด
Anchor link toในกรณีที่คำขอของคุณมีรูปแบบไม่ถูกต้อง พบปัญหาในการประมวลผล หรือเกิดข้อผิดพลาดอื่นๆ Pushwoosh จะส่งรหัสข้อผิดพลาดที่ระบุลักษณะของปัญหาให้คุณ ซึ่งจะช่วยให้คุณสามารถแก้ไขและจัดการปัญหาได้อย่างมีประสิทธิภาพ
| รหัสสถานะ HTTP | ข้อความสถานะ | คำอธิบาย |
|---|---|---|
| 400 | Bad request (คำขอไม่ถูกต้อง) | ไม่สามารถดำเนินการตามคำขอได้เนื่องจากไวยากรณ์ไม่ถูกต้อง |
| 401 | Unauthorized (ไม่ได้รับอนุญาต) | การรับรองความถูกต้องล้มเหลวหรือไม่ได้รับการให้ข้อมูล |
| 403 | Token restrictions forbid this operation. (ข้อจำกัดของโทเค็นไม่อนุญาตให้ดำเนินการนี้) | โทเค็นการเข้าถึงของคุณไม่มีสิทธิ์ที่จำเป็นในการดำเนินการตามที่ร้องขอ หากต้องการแก้ไขปัญหานี้ ให้ตรวจสอบสิทธิ์ของโทเค็นการเข้าถึงของคุณใน Pushwoosh control panel และปรับเปลี่ยนตามความจำเป็นเพื่อให้ตรงกับข้อกำหนดสำหรับการดำเนินการเฉพาะที่คุณต้องการทำ |
| 404 | Resource not found (ไม่พบทรัพยากร) | บ่งชี้ว่าทรัพยากรที่ร้องขอ เช่น แอป ไม่สามารถระบุตำแหน่งได้หรือไม่พบบนเซิร์ฟเวอร์ |
| 500 | Internal error (ข้อผิดพลาดภายใน) | มีปัญหาหรือข้อผิดพลาดที่ไม่คาดคิดเกิดขึ้นบนเซิร์ฟเวอร์ขณะประมวลผลคำขอ API |