बाहरी एपीआई अनुरोध

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

परिभाषा

जिस सेवा प्रदाता से आप जुड़ना चाहते हैं, उसके एपीआई दस्तावेज में अनुरोध को कैसे संरचित किया जाना चाहिए, इसके विनिर्देशों से परामर्श लें।

1. एक नया अनुरोध टेम्पलेट परिभाषित करने के लिए, साइडबार (1) पर "बिजनेस लॉजिक" टैब पर जाएं, "बाहरी एपीआई अनुरोध" टैब (2) पर स्विच करें, और "नया एपीआई अनुरोध" (3) पर क्लिक करें।

2. नए अनुरोध को एक नाम दें और वैकल्पिक रूप से एक विवरण दें।

3. अनुरोध HTTP पद्धति और उसके URL का चयन करें।

4. URL पैरामीटर, क्वेरी पैरामीटर (केवल GET अनुरोधों के लिए), हेडर और अनुरोध के मुख्य भाग को पैरामीटर नाम (1), उसके प्रकार (2) को इनपुट करके और "पैरा जोड़ें" (3) पर क्लिक करके परिभाषित करें।

इन मापदंडों के वास्तविक मूल्य को व्यापार प्रक्रिया के निष्पादन के समय परिभाषित किया जाएगा, जहां अनुरोध ट्रिगर होता है।

यूआरएल और क्वेरी पैरामीटर के बीच अंतर को समझने के लिए, यहां और पढ़ें। हालांकि मानकों के बावजूद, जिस सेवा प्रदाता से आप जुड़ना चाहते हैं, उसका एपीआई दस्तावेज अनुरोध बनाने के तरीके के बारे में जानकारी का सबसे अच्छा स्रोत है।

आप नमूना JSON इनपुट करके अनुरोध हेडर और बॉडी को ऑटोफिल भी कर सकते हैं, सिस्टम स्वचालित रूप से सभी आवश्यक पैरामीटर बनाएगा।

आपको प्रत्येक टैब पर नए पैरामीटर जोड़ने की आवश्यकता नहीं है। उदाहरण के लिए, कुछ अनुरोधों में कोई URL पैरामीटर, हेडर या बॉडी बिल्कुल नहीं हो सकती है।

यदि आपके अनुरोध में ऑब्जेक्ट (जैसे कार -> रंग, आकार, आदि) शामिल हैं, तो आपको बाद में अपनी व्यावसायिक प्रक्रियाओं में इन ऑब्जेक्ट्स को प्रोसेस करने के लिए वर्चुअल मॉडल बनाना होगा। पैरामीटर प्रकार चयनकर्ता में "मॉडल" का चयन करके और आपको आवश्यक बाल तत्वों को पेश करके ऐसा करें। आप जितनी बार चाहें वस्तुओं को घोंसला बना सकते हैं (यानी वस्तु के भीतर वस्तु) और आभासी मॉडल सरणियाँ बना सकते हैं। यदि आपने ऑटोफिल का उपयोग किया है, तो यह प्रक्रिया अपने आप पूरी हो गई थी।

5. "सेटिंग" टैब में अनुरोध की सेटिंग बदलें, जैसे एसएसएल सत्यापन, टाइमआउट, और त्रुटि प्रबंधन।

6. "परीक्षण अनुरोध" पर क्लिक करके और सभी आवश्यक पैरामीटर दर्ज करके अनुरोध का परीक्षण करें। सर्वर से प्रतिक्रिया की जाँच करें और प्रतिक्रिया हेडर और बॉडी को स्वचालित रूप से ऑटोफिल करें, या मैन्युअल रूप से ऐसा करें।

7. "अनुरोध सहेजें" पर क्लिक करके अनुरोध टेम्पलेट सहेजें।

प्रयोग करना

आपके द्वारा नए अनुरोध को परिभाषित करने और सहेजने के बाद, इसे ट्रिगर करने के लिए बिजनेस प्रोसेस एडिटर में एक नया ब्लॉक उपलब्ध हो जाएगा।

आपको इसे उन सभी घटकों के साथ प्रदान करना होगा जिन्हें आप डेटा मॉडल के रूप में अनुरोध (यूआरएल और क्वेरी पैरामीटर, हेडर और बॉडी) में जोड़ना चाहते हैं, जिसे इन ब्लॉकों का उपयोग करके बनाया जा सकता है। आउटपुट में, आप प्रतिक्रिया के स्वरूपित निकाय, उसके शीर्षकों और प्रतिक्रिया स्थिति को निकालने में सक्षम होंगे। आप इन ब्लॉक्स का उपयोग करके इन मॉडलों का विस्तार कर सकते हैं।

अनुरोध को सही ढंग से ट्रिगर करने के लिए आपको सभी डेटा इनपुट कनेक्ट करने की आवश्यकता नहीं है। उदाहरण के लिए, यदि आपके पास कोई URL पैरामीटर वाला अनुरोध है, तो आपको उसका मॉडल बनाने और उसे कनेक्ट करने की आवश्यकता नहीं है।

आपके द्वारा परिभाषित प्रत्येक वर्चुअल मॉडल के लिए, इसे बनाने और विस्तारित करने के लिए आपके व्यवसाय प्रक्रिया संपादक में 2 नए ब्लॉक जोड़े जाएंगे।

निगरानी

हर बार जब आप एक एपीआई अनुरोध को ट्रिगर करते हैं, तो सिस्टम लॉग को उसके प्रकार और पते, अनुरोध निकाय, प्रतिक्रिया HTTP स्थिति कोड और प्रतिक्रिया निकाय को आउटपुट करेगा। आप अन्य जानकारी को आउटपुट कर सकते हैं, जैसे प्रतिक्रिया निकाय के विशिष्ट क्षेत्र, या लॉग टू लॉग ब्लॉक का उपयोग करके लॉग की विलंबता।