सामग्री पर जाएँ

डेटा, API और एकीकरण

वेबहुक

जब कोई ग्राहक बनाया जाता है, कोई आवेदन बदलता है, कोई वितरण अनुमोदित होता है और अन्य घटनाओं पर, अपने पते पर एक हस्ताक्षरित संदेश प्राप्त करें।

  • अद्यतन
  • प्रबंधकों के लिए

यह कौन कर सकता है: स्वामी और व्यवस्थापक

घटनाएँ

वेबहुक घटनाएँ
कार्यक्रमकब भेजा जाता है
client.createdकोई ग्राहक जोड़ा जाता है।
order.submittedकोई आवेदन किया जाता है।
order.approvedकोई आवेदन अनुमोदित होता है।
order.settledकिसी आवेदन का निपटान होता है और अंश जारी किए जाते हैं।
distribution.approvedकोई वितरण अनुमोदित होता है।
transfer.completedनिवेशकों के बीच कोई हस्तांतरण पूरा होता है।
message.receivedकोई ग्राहक संदेश भेजता है।

पेलोड में ID, संख्याएँ और राशियाँ होती हैं, लेकिन कोई व्यक्तिगत डेटा नहीं होता। आपका सिस्टम विवरण API कुंजी से प्राप्त करता है।

एंडपॉइंट जोड़ें

  1. सेटिंग्स, फिर वेबहुक खोलें, और एंडपॉइंट जोड़ें चुनें।
  2. एक https पता दर्ज करें जो कुछ ही सेकंड में 2xx स्थिति के साथ उत्तर देता हो। घटनाएँ चुनें।
  3. हस्ताक्षर की गोपनीय कुंजी कॉपी करें। यह केवल एक बार दिखाई जाती है।
  4. यह जाँचने के लिए कि वह पहुँचती है, परीक्षण घटना भेजें चुनें।
  • केवल सार्वजनिक होस्ट पर https पते स्वीकार किए जाते हैं। निजी या आंतरिक नेटवर्क की ओर इशारा करने वाले पते अस्वीकार कर दिए जाते हैं।
  • रीडायरेक्ट का पालन नहीं किया जाता।

हस्ताक्षर सत्यापित करें

हर डिलीवरी एक JSON POST होती है, जिसमें हेडर EasyHaus-Event, EasyHaus-Delivery और EasyHaus-Signature होते हैं। हस्ताक्षर t=<unix time>,v1=<hex> जैसा दिखता है। अपनी गोपनीय कुंजी से पाठ <t>.<raw body> का HMAC-SHA256 निकालें, उसकी तुलना v1 से करें, और पुराने टाइमस्टैम्प अस्वीकार करें।

बॉडी {id, type, created_at, organization_id, data} होती है।

पुनः प्रयास और बंद होना

  • 10 सेकंड के भीतर उत्तर दें। विफल डिलीवरी को बढ़ते अंतराल के साथ अधिकतम 10 प्रयासों तक दोबारा भेजा जाता है।
  • लगातार 20 विफलताओं के बाद एंडपॉइंट बंद कर दिया जाता है और स्वामियों तथा व्यवस्थापकों को ईमेल भेजा जाता है। इसे ठीक करें, फिर इसे दोबारा चालू करें, जिससे गिनती शून्य हो जाती है।
  • वितरण लॉग हर डिलीवरी, उसकी स्थिति और HTTP कोड दिखाता है, और आपको फिर भेजें की सुविधा देता है।
  • आप घटनाएँ संपादित कर सकते हैं, एंडपॉइंट बंद कर सकते हैं, गोपनीय कुंजी बदल सकते हैं (पुरानी कुंजी तुरंत काम करना बंद कर देती है) या उसे हटा सकते हैं।

जो चाहिए वह नहीं मिला?

हमें बताएँ कि आप क्या करने की कोशिश कर रहे थे। हम ईमेल से जवाब देते हैं और आपका प्रश्न अगली मार्गदर्शिका लिखने में मदद करता है। पासवर्ड, पहचान संख्या या बैंक विवरण कभी न भेजें।