Pushwoosh API का अवलोकन

Pushwoosh API डेवलपर्स को Pushwoosh प्लेटफॉर्म के साथ इंटरैक्ट करने की अनुमति देता है।

आप Pushwoosh API के साथ क्या कर सकते हैं?

Pushwoosh API के साथ आपको 100 से अधिक विधियों की एक विस्तृत लाइब्रेरी तक पहुंच प्राप्त होती है जो आपको सक्षम बनाती है:

व्यक्तिगत पुश नोटिफिकेशन भेजें
सटीक लक्ष्यीकरण के लिए उपयोगकर्ता खंड बनाएं, आयात करें, निर्यात करें और प्रबंधित करें
बैच में उपयोगकर्ताओं/उपकरणों को प्रबंधित करने के लिए बल्क API का उपयोग करें
एप्लिकेशन कॉन्फ़िगर करें
लक्ष्यीकरण और वैयक्तिकरण को बढ़ाने के लिए उपयोगकर्ता ईवेंट ट्रैक करें और उपयोगकर्ताओं में टैग जोड़ें
Pushwoosh एंटिटीज़ जैसे प्रीसेट, टैग, ईवेंट, एप्लिकेशन आदि बनाएं और प्रबंधित करें।
API के माध्यम से Pushwoosh Customer Journeys शुरू करें
Customer Journeys और Push/Email/SMS अभियानों पर व्यापक आँकड़े प्राप्त करें।
जब उपयोगकर्ता विशिष्ट भौगोलिक क्षेत्रों में प्रवेश करते हैं या बाहर निकलते हैं तो स्थान-आधारित सूचनाएं भेजने के लिए जियोफेंसिंग लागू करें
Pushwoosh के साथ तीसरे पक्ष की सेवाओं को निर्बाध रूप से एकीकृत करें

उपलब्ध विधियों की पूरी श्रृंखला का पता लगाने और Pushwoosh API की व्यापक क्षमताओं की खोज करने के लिए, कृपया API विधियों के संदर्भ सूचकांक का संदर्भ लें।

प्रमाणीकरण

Pushwoosh API अनुरोधों को प्रमाणित करने के लिए API टोकन का उपयोग करता है। दो प्रकार के टोकन हैं: सर्वर और डिवाइस, प्रत्येक का उपयोग विशिष्ट API स्कोप के लिए किया जाता है।

प्रत्येक Pushwoosh खाते में Pushwoosh डेमो ऐप के लिए बनाया गया एक डिफ़ॉल्ट API एक्सेस टोकन होता है। आप Pushwoosh कंट्रोल पैनल में अपने API टोकन देख, बना और प्रबंधित कर सकते हैं।

और जानें

दर सीमाएं

दर सीमा उन अनुरोधों की संख्या है जो API एक निश्चित अवधि में प्राप्त कर सकता है। जबकि Pushwoosh में अधिकांश API अनुरोध सीमित नहीं हैं, /createMessage और समकक्ष Messaging API v2 Notify अनुरोध सभी उपयोगकर्ताओं के लिए सेवा की गुणवत्ता सुनिश्चित करने के लिए प्रति मिनट 600 पर सीमित हैं।

अनुरोध

सुरक्षित डेटा ट्रांसफर सुनिश्चित करने के लिए सभी API अनुरोधों के लिए HTTPS अनिवार्य है।

प्रतिक्रियाएं

Pushwoosh API आमतौर पर JSON प्रतिक्रियाएं लौटाता है।

सफलता और त्रुटि कोड

सफलता कोड

जब आपका API अनुरोध सफलतापूर्वक संसाधित हो जाता है, तो आपको प्रतिक्रिया के हिस्से के रूप में एक सफलता कोड प्राप्त होगा।

HTTP स्थिति कोड	स्थिति संदेश	विवरण
200	ठीक है	Pushwoosh ने अनुरोध को सफलतापूर्वक संसाधित किया

कृपया ध्यान दें कि जब आपको HTTP 200 प्रतिक्रिया मिलती है, तो इसका मतलब है कि आपका अनुरोध समझा गया और सफलतापूर्वक संसाधित किया गया, लेकिन यह कार्रवाई की सफलता की गारंटी नहीं देता है। इसलिए कार्रवाई की सफलता निर्धारित करने के लिए त्रुटि या चेतावनी संदेशों (एक्सेस अस्वीकृत, एप्लिकेशन नहीं मिला, अमान्य API कुंजी, आदि) की जांच करना सुनिश्चित करें।

स्थिति कोड	स्थिति संदेश
200	चेतावनी: आप ग्राहक सीमा तक पहुंच गए हैं। पुश संदेश केवल 1 यादृच्छिक डिवाइस पर भेजा जाएगा
200	चेतावनी: आपने अपनी वर्तमान सदस्यता योजना पर अनुमत सक्रिय उपकरणों की संख्या पार कर ली है।
210	एक्सेस अस्वीकृत या एप्लिकेशन नहीं मिला
210	एप्लिकेशन नहीं मिला
210	एप्लिकेशन निलंबित
210	खाता नहीं मिला
210	खाता निलंबित कर दिया गया है
210	निलंबित खाता डिवाइस फ़िल्टरेशन का उपयोग नहीं कर सकता
210	API टोकन या एप्लिकेशन सेट नहीं है
210	कृपया कम से कम एक प्लेटफ़ॉर्म चुनें
210	अमान्य API टोकन: खाता नहीं मिला
210	कोई एप्लिकेशन या समूह कोड नहीं दिया गया
210	API टोकन या एप्लिकेशन या खाता सेट नहीं है

त्रुटि कोड

यदि आपका अनुरोध सही ढंग से स्वरूपित नहीं है, प्रसंस्करण समस्याओं का सामना करता है, या किसी अन्य त्रुटि का अनुभव करता है, तो Pushwoosh आपको समस्या की प्रकृति को इंगित करने वाला एक त्रुटि कोड भेजेगा, जो आपको समस्या का निवारण करने और प्रभावी ढंग से संबोधित करने में मदद करेगा।

HTTP स्थिति कोड	स्थिति संदेश	विवरण
400	खराब अनुरोध	खराब सिंटैक्स के कारण अनुरोध पूरा नहीं किया जा सकता
401	अनधिकृत	प्रमाणीकरण विफल हो गया है या प्रदान नहीं किया गया है
403	टोकन प्रतिबंध इस ऑपरेशन को प्रतिबंधित करते हैं।	आपके एक्सेस टोकन में अनुरोधित कार्रवाई करने के लिए आवश्यक अनुमतियाँ नहीं हैं। इसे ठीक करने के लिए, Pushwoosh कंट्रोल पैनल में अपने एक्सेस टोकन की अनुमतियों की समीक्षा करें और उन्हें उस विशिष्ट ऑपरेशन की आवश्यकताओं से मेल खाने के लिए आवश्यकतानुसार समायोजित करें जिसे आप करना चाहते हैं।
404	संसाधन नहीं मिला	इंगित करता है कि अनुरोधित संसाधन, जैसे कि एक ऐप, स्थित नहीं किया जा सका या सर्वर पर मौजूद नहीं है।
500	आंतरिक त्रुटि	API अनुरोध को संसाधित करते समय सर्वर पर एक अप्रत्याशित समस्या या त्रुटि हुई थी।