ภาพรวม Pushwoosh API

Pushwoosh API ช่วยให้นักพัฒนาสามารถโต้ตอบกับแพลตฟอร์ม Pushwoosh ได้

คุณสามารถทำอะไรได้บ้างด้วย Pushwoosh API?

ด้วย Pushwoosh API คุณจะเข้าถึงไลบรารีที่กว้างขวางของเมธอดกว่า 100 รายการที่ช่วยให้คุณสามารถ:

• ส่งการแจ้งเตือนแบบ push ส่วนบุคคล
• สร้าง นำเข้า ส่งออก และจัดการ Segment ผู้ใช้เพื่อการกำหนดเป้าหมายที่แม่นยำ
• ใช้ Bulk API เพื่อจัดการผู้ใช้/อุปกรณ์เป็นชุด
• กำหนดค่า Application
• ติดตาม Event ผู้ใช้และเพิ่ม Tag ให้ผู้ใช้เพื่อเพิ่มประสิทธิภาพการกำหนดเป้าหมายและการปรับเปลี่ยนในแบบของคุณ
• สร้างและจัดการ Pushwoosh Entities เช่น Presets, Tags, Events, Applications เป็นต้น
• เริ่ม Pushwoosh Customer Journeys ผ่าน API
• ดึงสถิติที่ครอบคลุมเกี่ยวกับ Customer Journeys และ Push/Email/SMS Campaigns
• ใช้ Geofencing เพื่อส่งการแจ้งเตือนตามตำแหน่งเมื่อผู้ใช้เข้าหรือออกจากพื้นที่ทางภูมิศาสตร์ที่กำหนด
• ผสานรวม 3rd party services กับ Pushwoosh ได้อย่างราบรื่น

หากต้องการสำรวจเมธอดทั้งหมดที่มีและค้นพบความสามารถที่กว้างขวางของ Pushwoosh API โปรดดูที่ ดัชนีอ้างอิงเมธอด API

การยืนยันตัวตน

Pushwoosh API ใช้ API Token เพื่อยืนยันตัวตนคำขอ มี Token สองประเภท: Server และ Device ซึ่งแต่ละประเภทใช้สำหรับขอบเขต API ที่เฉพาะเจาะจง

บัญชี Pushwoosh แต่ละบัญชีมาพร้อมกับ API Access Token เริ่มต้นที่สร้างขึ้นสำหรับ Pushwoosh Demo App คุณสามารถดู สร้าง และจัดการ API Token ของคุณได้ใน Pushwoosh Control Panel

เรียนรู้เพิ่มเติม

ข้อจำกัดอัตรา

ข้อจำกัดอัตราคือจำนวนคำขอที่ API สามารถรับได้ในระยะเวลาที่กำหนด แม้ว่าคำขอ API ส่วนใหญ่ใน Pushwoosh จะไม่มีข้อจำกัด แต่คำขอ API /createMessage ถูกจำกัดไว้ที่ 600 ครั้งต่อนาที เพื่อให้มั่นใจในคุณภาพบริการสำหรับผู้ใช้ทุกคน

คำขอ

HTTPS เป็นสิ่งจำเป็นสำหรับคำขอ API ทั้งหมด เพื่อให้มั่นใจในการถ่ายโอนข้อมูลที่ปลอดภัย

การตอบกลับ

Pushwoosh API โดยทั่วไปจะส่งคืนการตอบกลับแบบ JSON

รหัสความสำเร็จและข้อผิดพลาด

รหัสความสำเร็จ

เมื่อคำขอ API ของคุณได้รับการประมวลผลสำเร็จ คุณจะได้รับรหัสความสำเร็จเป็นส่วนหนึ่งของการตอบกลับ

รหัสสถานะ HTTP	ข้อความสถานะ	คำอธิบาย
200	OK	Pushwoosh ประมวลผลคำขอสำเร็จ

โปรดทราบว่าเมื่อคุณได้รับการตอบกลับ HTTP 200 หมายความว่าคำขอของคุณได้รับการเข้าใจและประมวลผลสำเร็จ แต่ไม่ได้รับประกันความสำเร็จของการดำเนินการ ดังนั้นโปรดตรวจสอบข้อความข้อผิดพลาดหรือคำเตือน (เช่น การเข้าถึงถูกปฏิเสธ, ไม่พบ Application, API key ไม่ถูกต้อง เป็นต้น) เพื่อพิจารณาความสำเร็จของการดำเนินการ

รหัสสถานะ	ข้อความสถานะ
200	คำเตือน: คุณถึงขีดจำกัดผู้สมัครสมาชิกแล้ว Push Message จะถูกส่งไปยังอุปกรณ์สุ่มเพียง 1 เครื่องเท่านั้น
200	คำเตือน: คุณเกินจำนวนอุปกรณ์ที่ใช้งานได้ที่อนุญาตในแผนการสมัครสมาชิกปัจจุบันของคุณแล้ว
210	การเข้าถึงถูกปฏิเสธหรือไม่พบ Application
210	ไม่พบ Application
210	Application ถูกระงับ
210	ไม่พบ Account
210	Account ถูกระงับ
210	Account ที่ถูกระงับไม่สามารถใช้การกรองอุปกรณ์ได้
210	ไม่ได้ตั้งค่า API token หรือ Application
210	โปรดเลือกอย่างน้อยหนึ่งแพลตฟอร์ม
210	API Token ไม่ถูกต้อง: ไม่พบ Account
210	ไม่ได้ระบุ Application หรือรหัสกลุ่ม
210	ไม่ได้ตั้งค่า API token หรือ Application หรือ Account

รหัสข้อผิดพลาด

ในกรณีที่คำขอของคุณไม่ได้จัดรูปแบบอย่างถูกต้อง พบปัญหาในการประมวลผล หรือประสบข้อผิดพลาดอื่นใด Pushwoosh จะส่งรหัสข้อผิดพลาดให้คุณเพื่อระบุลักษณะของปัญหา ช่วยให้คุณแก้ไขปัญหาและจัดการปัญหาได้อย่างมีประสิทธิภาพ

รหัสสถานะ HTTP	ข้อความสถานะ	คำอธิบาย
400	คำขอไม่ถูกต้อง	ไม่สามารถดำเนินการตามคำขอได้เนื่องจากไวยากรณ์ไม่ถูกต้อง
401	ไม่ได้รับอนุญาต	การยืนยันตัวตนล้มเหลวหรือไม่ได้รับการให้
403	ข้อจำกัดของ Token ไม่อนุญาตให้ดำเนินการนี้	Access token ของคุณไม่มีสิทธิ์ที่จำเป็นในการดำเนินการตามคำขอ ในการแก้ไขปัญหานี้ โปรดตรวจสอบสิทธิ์ของ Access token ของคุณใน Pushwoosh Control Panel และปรับเปลี่ยนตามความจำเป็นเพื่อให้ตรงกับข้อกำหนดสำหรับการดำเนินการเฉพาะที่คุณต้องการดำเนินการ
404	ไม่พบ Resource	ระบุว่า Resource ที่ร้องขอ เช่น App ไม่สามารถค้นหาได้หรือไม่มีอยู่บนเซิร์ฟเวอร์
500	ข้อผิดพลาดภายใน	เกิดปัญหาหรือข้อผิดพลาดที่ไม่คาดคิดบนเซิร์ฟเวอร์ขณะประมวลผลคำขอ API