वेबहुक्स

वेबहुक्स आपको Meshy से रीयल-टाइम अपडेट प्राप्त करने की अनुमति देते हैं जब आपके API कार्य पूरे होते हैं या स्थिति बदलती है। एक बार कॉन्फ़िगर करने के बाद, Meshy आपके द्वारा निर्दिष्ट किए गए URLs पर json प्रारूप में इवेंट पेलोड्स को POST करेगा।

वेबहुक्स क्यों बनाएं

वेबहुक्स का उपयोग करने के कई फायदे हैं, विशेष रूप से API कार्य स्थितियों की स्वचालित जांच के संबंध में। वेबहुक्स API को लगातार पॉल करने की तुलना में कम प्रयास और लागत की आवश्यकता होती है ताकि कार्य स्थिति अपडेट प्राप्त हो सके। वेबहुक्स लगभग रीयल-टाइम अपडेट की अनुमति देते हैं और अंततः API पॉलिंग की तुलना में बेहतर स्केल करते हैं। यह आपको अपनी दर सीमाओं को बेहतर ढंग से प्रबंधित करने में सक्षम बनाता है, विशेष रूप से यदि आप लगातार पॉल कर रहे हैं।

सेटअप और कॉन्फ़िगरेशन

वेबहुक्स को सक्षम करने के लिए, Meshy वेब एप्लिकेशन में लॉग इन करने पर API सेटिंग्स पृष्ठ पर जाएं। अपने API Keys के नीचे "वेबहुक्स" अनुभाग खोजें और "वेबहुक बनाएं" बटन पर क्लिक करें। वेबहुक्स प्राप्त करने के लिए अपनी इच्छित https URL प्रदान करें और Meshy से स्वचालित रूप से कार्य अपडेट प्राप्त करने के लिए वेबहुक को सक्षम करें। आपके Meshy खाते में अधिकतम 5 सक्रिय वेबहुक्स हो सकते हैं। जब एक वेबहुक सक्षम होता है, तो सभी API कार्य स्थिति अपडेट स्वचालित रूप से पेलोड URL पर भेजे जाएंगे। सुरक्षा उद्देश्यों के लिए, हम इस समय केवल https URLs पर वेबहुक्स भेजने की अनुमति देते हैं। यदि आप स्थानीय परीक्षण कॉन्फ़िगर करना चाहते हैं, तो निम्नलिखित अनुभाग देखें।

वेबहुक डिलीवरी आवश्यकताएँ

आपके वेबहुक को सामान्य रूप से कार्य करने और इवेंट्स प्राप्त करने के लिए:

  • आपके सर्वर को HTTP स्टेटस कोड 400 से नीचे (जैसे, 200 OK, 202 Accepted) के साथ प्रतिक्रिया देनी चाहिए।
  • कोई भी प्रतिक्रिया जिसमें स्टेटस कोड >= 400 होगा, उसे विफल डिलीवरी के रूप में माना जाएगा।
  • लगातार कई विफलताएं हो सकती हैं:
    • प्रगति अपडेट में देरी हो सकती है या वे क्रम से बाहर आ सकते हैं
    • आपके वेबहुक को स्वचालित रूप से कई प्रयासों के बाद अक्षम कर दिया जा सकता है (स्वचालित अक्षम नीति देखें)

सुझाव: हमेशा वेबहुक पेलोड को मान्य और संग्रहीत करने के बाद एक सफलता प्रतिक्रिया लौटाएं, भले ही आगे की प्रोसेसिंग असिंक्रोनस रूप से हो।

स्थानीय परीक्षण के लिए वेबहुक्स को अग्रेषित करना

यदि आप अपने वेबहुक कोड का स्थानीय रूप से परीक्षण करना चाहते हैं, जो आमतौर पर एक http पते पर होता है, तो आप वेबहुक प्रॉक्सी URL का उपयोग करके वेबहुक्स को अपने कंप्यूटर या कोडस्पेस पर अग्रेषित कर सकते हैं। नीचे दिए गए smee.io का उपयोग करके अनुशंसित कदम हैं, लेकिन आप किसी भी सेवा का उपयोग कर सकते हैं जिसे आप वेबहुक प्रॉक्सी URL उत्पन्न करने के लिए पसंद करते हैं।

वेबहुक प्रॉक्सी URL प्राप्त करें:

  1. अपने ब्राउज़र में, https://smee.io/ पर जाएं
  2. "Start a new channel" पर क्लिक करें
  3. "Webhook Proxy URL" के अंतर्गत पूर्ण URL कॉपी करें। आप इस URL का उपयोग निम्नलिखित सेटअप चरणों में करेंगे।

वेबहुक्स को अग्रेषित करें:

  1. यदि आपके पास पहले से smee-client इंस्टॉल नहीं है, तो अपने टर्मिनल में निम्नलिखित कमांड चलाएं।
npm install --global smee-client
  1. smee.io से अग्रेषित वेबहुक्स प्राप्त करने के लिए, अपने टर्मिनल में निम्नलिखित कमांड चलाएं। WEBHOOK_PROXY_URL को पहले के वेबहुक प्रॉक्सी URL से बदलें।
smee --url WEBHOOK_PROXY_URL --path /webhook --port 3000

आपको ऐसा आउटपुट दिखाई देगा, जहाँ WEBHOOK_PROXY_URL आपका वेबहुक प्रॉक्सी URL है:

Forwarding WEBHOOK_PROXY_URL to http://127.0.0.1:3000/webhook
Connected WEBHOOK_PROXY_URL
  1. जब आप अपने वेबहुक का परीक्षण कर रहे हों, तो इसे चलाते रहें। जब आप वेबहुक्स को अग्रेषित करना बंद करना चाहते हैं, तो Ctrl+C दर्ज करें।
    ध्यान दें कि पथ /webhook है और पोर्ट 3000 है। ये मान तब काम आ सकते हैं जब आप बाद में वेबहुक डिलीवरी प्राप्त करने के लिए अपना कोड सेट करना चाहें।

वेबहुक बनाएं:

अब आप Meshy API सेटिंग्स पृष्ठ में एक नया वेबहुक बनाने के लिए वेबहुक प्रॉक्सी URL का उपयोग कर सकते हैं।

नमूना प्रतिक्रिया

जब एक कार्य की स्थिति बदलती है, तो Meshy आपके कॉन्फ़िगर किए गए URL पर एक वेबहुक पेलोड POST करेगा। पेलोड JSON प्रारूप में कार्य ऑब्जेक्ट को शामिल करता है। सभी कार्य ऑब्जेक्ट गुणों और उदाहरण पेलोड्स का पूरा विवरण देखने के लिए, देखें: