ภาพรวม Pushwoosh API
Pushwoosh API ช่วยให้นักพัฒนาสามารถโต้ตอบกับแพลตฟอร์ม Pushwoosh ได้
คุณสามารถทำอะไรกับ Pushwoosh API ได้บ้าง?
Anchor link toด้วย Pushwoosh API คุณจะสามารถเข้าถึงไลบรารีที่ครอบคลุมกว่า 100 เมธอด ซึ่งช่วยให้คุณสามารถ:
- ส่ง push notifications ส่วนบุคคล
- สร้าง นำเข้า ส่งออก และจัดการกลุ่มผู้ใช้เพื่อการกำหนดเป้าหมายที่แม่นยำ
- ใช้ bulk APIs เพื่อจัดการผู้ใช้/อุปกรณ์เป็นชุด
- กำหนดค่าแอปพลิเคชัน
- ติดตาม event ของผู้ใช้และเพิ่ม tag ให้กับผู้ใช้เพื่อปรับปรุงการกำหนดเป้าหมายและการปรับเปลี่ยนในแบบของคุณ
- สร้างและจัดการ Pushwoosh Entities เช่น presets, tags, events, applications และอื่นๆ
- เริ่มต้น Pushwoosh Customer Journeys ผ่าน API
- ดึงข้อมูลสถิติที่ครอบคลุมเกี่ยวกับ Customer Journeys และแคมเปญ Push/Email/SMS
- ใช้ geofencing เพื่อส่งการแจ้งเตือนตามตำแหน่งเมื่อผู้ใช้เข้าหรือออกจากพื้นที่ทางภูมิศาสตร์ที่ระบุ
- ผสานรวมบริการของบุคคลที่สามกับ Pushwoosh ได้อย่างราบรื่น
หากต้องการสำรวจเมธอดทั้งหมดที่มีอยู่และค้นพบความสามารถที่ครอบคลุมของ Pushwoosh API โปรดดูที่ ดัชนีอ้างอิงเมธอด API
การยืนยันตัวตน
Anchor link toPushwoosh API ใช้ API tokens เพื่อยืนยันตัวตนคำขอ มีโทเค็นสองประเภทคือ: Server และ Device ซึ่งแต่ละประเภทใช้สำหรับขอบเขต API ที่เฉพาะเจาะจง
แต่ละบัญชี Pushwoosh จะมาพร้อมกับ API Access Token เริ่มต้นที่สร้างขึ้นสำหรับ Pushwoosh Demo App คุณสามารถดู สร้าง และจัดการ API tokens ของคุณได้ใน Pushwoosh Control Panel
ขีดจำกัดอัตรา
Anchor link toขีดจำกัดอัตราคือจำนวนคำขอที่ API สามารถรับได้ในช่วงเวลาที่กำหนด แม้ว่าคำขอ API ส่วนใหญ่ใน Pushwoosh จะไม่จำกัด แต่คำขอ /createMessage และคำขอ Messaging API v2 Notify ที่เทียบเท่ากันจะถูกจำกัดไว้ที่ 600 คำขอต่อนาทีเพื่อรับประกันคุณภาพการบริการสำหรับผู้ใช้ทุกคน
คำขอ
Anchor link toHTTPS เป็นสิ่งจำเป็นสำหรับคำขอ API ทั้งหมดเพื่อรับประกันการถ่ายโอนข้อมูลที่ปลอดภัย
การตอบกลับ
Anchor link toโดยทั่วไป Pushwoosh API จะส่งคืนการตอบกลับในรูปแบบ JSON
รหัสความสำเร็จและข้อผิดพลาด
Anchor link toรหัสความสำเร็จ
Anchor link toเมื่อคำขอ API ของคุณได้รับการประมวลผลสำเร็จ คุณจะได้รับรหัสความสำเร็จเป็นส่วนหนึ่งของการตอบกลับ
| รหัสสถานะ HTTP | ข้อความสถานะ | คำอธิบาย |
|---|---|---|
| 200 | OK | Pushwoosh ประมวลผลคำขอสำเร็จ |
โปรดทราบว่าเมื่อคุณได้รับการตอบกลับ HTTP 200 หมายความว่าคำขอของคุณเป็นที่เข้าใจและได้รับการประมวลผลสำเร็จ แต่ไม่ได้รับประกันความสำเร็จของการดำเนินการ ดังนั้นโปรดตรวจสอบข้อความแสดงข้อผิดพลาดหรือคำเตือน (access denied, application not found, invalid API key และอื่นๆ) เพื่อพิจารณาความสำเร็จของการดำเนินการ
| รหัสสถานะ | ข้อความสถานะ |
|---|---|
| 200 | Warnings: You have reached the subscriber limit. Push Message will be sent to 1 random device only |
| 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 |
| 210 | Please select at least one platform |
| 210 | Invalid API Token: Account not found |
| 210 | No application or group code given |
| 210 | API token or application or account is not set |
รหัสข้อผิดพลาด
Anchor link toในกรณีที่คำขอของคุณมีรูปแบบไม่ถูกต้อง พบปัญหาในการประมวลผล หรือพบข้อผิดพลาดอื่นๆ Pushwoosh จะส่งรหัสข้อผิดพลาดที่ระบุลักษณะของปัญหาให้คุณ ซึ่งจะช่วยให้คุณแก้ไขปัญหาและจัดการกับปัญหาได้อย่างมีประสิทธิภาพ
| รหัสสถานะ HTTP | ข้อความสถานะ | คำอธิบาย |
|---|---|---|
| 400 | Bad request | ไม่สามารถดำเนินการตามคำขอได้เนื่องจากไวยากรณ์ไม่ถูกต้อง |
| 401 | Unauthorized | การยืนยันตัวตนล้มเหลวหรือไม่ได้รับการระบุ |
| 403 | Token restrictions forbid this operation. | access token ของคุณไม่มีสิทธิ์ที่จำเป็นในการดำเนินการตามที่ร้องขอ หากต้องการแก้ไขปัญหานี้ ให้ตรวจสอบสิทธิ์ของ access token ของคุณใน Pushwoosh control panel และปรับเปลี่ยนตามความจำเป็นเพื่อให้ตรงกับข้อกำหนดสำหรับการดำเนินการเฉพาะที่คุณต้องการทำ |
| 404 | Resource not found | ระบุว่าทรัพยากรที่ร้องขอ เช่น แอป ไม่พบหรือไม่พบบนเซิร์ฟเวอร์ |
| 500 | Internal error | มีปัญหาหรือข้อผิดพลาดที่ไม่คาดคิดเกิดขึ้นบนเซิร์ฟเวอร์ขณะประมวลผลคำขอ API |