Power Apps में एक कस्टम API बनाएँ

यह आलेख बताता है कि समाधान का उपयोग करके Microsoft Dataverse के लिए Power Apps में कस्टम API कैसे बनाया जाए. अनुरोध और प्रतिक्रिया गुणों को परिभाषित करने, कस्टम एपीआई का परीक्षण करने और इसके प्लग-इन प्रकार को संबद्ध करने के लिए इन चरणों का पालन करें। यदि आप समाधानों से परिचित नहीं हैं, तो पहले समाधान बनाएँ पढ़ें.

आपका समाधान किसी प्रकाशक से संबद्ध होना चाहिए. प्रकाशक के पास इसके साथ एक विशिष्ट अनुकूलन उपसर्ग संबद्ध है। कस्टम API बनाते समय आपको अनुकूलन उपसर्ग का उपयोग करना चाहिए और यह उपसर्ग वही उपसर्ग होना चाहिए जिसका उपयोग आपके समाधान के प्रकाशक द्वारा किया जाता है. निम्न निर्देश मान को sample अनुकूलन उपसर्ग के रूप में उपयोग करते हैं क्योंकि यह प्रकाशक के लिए एक सेट है.

महत्त्वपूर्ण

• कस्टम एपीआई बनाने के लिए अब एक बेहतर अनुभव है। आप प्लग-इन पंजीकरण उपकरण के भीतर एक डिज़ाइनर का उपयोग कर सकते हैं। अधिक जानकारी के लिए, प्लग-इन पंजीकरण टूल का उपयोग करके एक कस्टम API बनाएँ देखें.
• आप कस्टम API बनाने से संबंधित कई फ़ील्ड को बनाने के बाद उन्हें नहीं बदल सकते. शुरू करने से पहले कस्टम एपीआई के डिज़ाइन की सावधानीपूर्वक योजना बनाएं। यदि आप बाद में निर्णय लेते हैं कि आपको इन फ़ील्ड को बदलने की आवश्यकता है, तो आपको मौजूदा रिकॉर्ड को हटाने और कस्टम API को फिर से बनाने की आवश्यकता हो सकती है। अधिक जानकारी के लिए, CustomAPI तालिकाएँ देखें.

एक कस्टम API रिकॉर्ड बनाएँ

1. अपने समाधान में, ड्रॉप-डाउन से नया और>अधिक>अन्य>कस्टम एपीआई चुनें.

2. अपने कस्टम API के गुण सेट करने के लिए फ़ील्ड संपादित करें. निम्न फ़ील्ड्स के लिए मान सेट करें. अधिक जानकारी के लिए, कस्टम API तालिका स्तंभ देखें.

   प्लग-इन बनाने से पहले आप प्लग-इन प्रकार के लिए मान सेट नहीं कर सकते. आप इस मान को बाद में बदल सकते हैं।

3. सहेजें चुनें. आपका फ़ॉर्म निम्न छवि के समान दिखना चाहिए:

अनुरोध पैरामीटर बनाएं

एक कस्टम एपीआई को पैरामीटर की आवश्यकता नहीं होती है। अपने तर्क के लिए आवश्यक डेटा पास करने के लिए जितने आवश्यक हैं उतने पैरामीटर बनाएं।

1. अपने समाधान में, ड्रॉप-डाउन से नया और>अधिक>अन्य>कस्टम API अनुरोध पैरामीटर चुनें.

2. अपने कस्टम API अनुरोध पैरामीटर के गुण सेट करने के लिए फ़ील्ड संपादित करें. अधिक जानकारी के लिए, CustomAPIRequestParameter तालिका स्तंभ देखें.

3. सहेजें चुनें. आपका फॉर्म निम्न छवि के समान दिखना चाहिए:

   

प्रतिक्रिया गुण बनाएँ

एक कस्टम एपीआई जो एक कार्रवाई का प्रतिनिधित्व करता है, उसे प्रतिक्रिया गुणों की आवश्यकता नहीं होती है। एक फ़ंक्शन में कम से कम एक होना चाहिए। यदि ऑपरेशन सफल होता है, तो यह एक सफलता प्रतिक्रिया देता है। यदि यह विफल हो जाता है, तो यह एक त्रुटि लौटाता है। आपके API द्वारा लौटाए जाने वाले किसी भी डेटा के लिए प्रतिक्रिया गुणों को परिभाषित करें।

यदि आप केवल एक निकाय या निकाय संग्रह प्रतिसाद गुण को परिभाषित करते हैं, तो प्रतिसाद उस प्रकार का होता है. यदि आप एक से अधिक गुणों, या एक साधारण प्रकार के एक या अधिक गुणों को परिभाषित करते हैं, तो एपीआई एक जटिल प्रकार देता है जहां प्रत्येक प्रतिक्रिया गुण उस जटिल प्रकार की संपत्ति है।

उदाहरण के लिए, यदि आपका कस्टम API अद्वितीय नाम है sample_CustomAPIExample, तो यह आपके द्वारा परिभाषित प्रत्येक प्रतिक्रिया गुण के लिए गुणों के साथ नामित sample_CustomAPIExampleResponse एक जटिल प्रकार लौटाता है।

1. अपने समाधान में, ड्रॉप-डाउन से नई अधिक>अन्य>>कस्टम API प्रतिक्रिया प्रॉपर्टी चुनें.

2. अपने कस्टम API रिस्पॉन्स प्रॉपर्टी के प्रॉपर्टी सेट करने के लिए फ़ील्ड में बदलाव करें. अधिक जानकारी के लिए, CustomAPIResponseProperty तालिका स्तंभ देखें.

3. सहेजें चुनें. आपका फॉर्म निम्न छवि के समान दिखना चाहिए:

   

सेवा दस्तावेज़ में परिणाम का निरीक्षण करें

यदि आप अपने कस्टम API के लिए प्रॉपर्टी सेट IsPrivate नहीं करते हैं, तो आप अनुरोध का उपयोग करके GETCSDL $metadata दस्तावेज़ से सेवा परिभाषा प्राप्त कर सकते हैं, यहां तक कि अपने ब्राउज़र से भी. यदि आपके परिवेश के लिए URL है https://yourorg.crm.dynamics.com, तो आप $metadata पुनर्प्राप्त करने के लिए इस URL को अपने ब्राउज़र पता फ़ील्ड में टाइप कर सकते हैं: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

कस्टम एपीआई का नाम खोजने के लिए परिणाम खोजें। उदाहरण के लिए, पिछले चरणों का उपयोग करके परिभाषित एपीआई इस तरह दिखता है:

<ComplexType Name="sample_CustomAPIExampleResponse">
    <Property Name="StringProperty" Type="Edm.String" Unicode="false" />
</ComplexType>
<Action Name="sample_CustomAPIExample">
    <Parameter Name="StringParameter" Type="Edm.String" Nullable="false" Unicode="false" />
    <ReturnType Type="mscrm.sample_CustomAPIExampleResponse" Nullable="false" />
</Action>

अपने कस्टम एपीआई का परीक्षण करें

अपना कस्टम एपीआई बनाने के बाद, आप इसे आज़मा सकते हैं। यहां तक कि अगर आप मुख्य ऑपरेशन को परिभाषित करने के लिए प्लग-इन प्रकार सेट नहीं करते हैं, तो आप यह सत्यापित करने के लिए अभी इसका परीक्षण कर सकते हैं कि आप इसे सही ढंग से कॉल कर सकते हैं। कोई भी प्रतिसाद गुण अपना डिफ़ॉल्ट मान लौटाते हैं, जैसे कि शून्य. ज़्यादा जानकारी के लिए, कस्टम API लागू करना देखें.

कस्टम एपीआई प्लग-इन प्रकार को अपडेट करें

कस्टम API के लिए प्लग-इन लिखने के तरीके के बारे में जानकारी के लिए, अपने कस्टम API के लिए प्लग-इन लिखना देखें.

अपनी असेंबली पंजीकृत करने के बाद, आपको अपने द्वारा बनाए गए कस्टम एपीआई के लिए प्लगइन प्रकार मान सेट करना होगा। यह मान एक लुकअप प्रॉपर्टी है, इसलिए आपको बस प्लग-इन प्रकार को खोजने की आवश्यकता है जो उस प्रकार का प्रतिनिधित्व करता है जब आपने असेंबली पंजीकृत की थी।

प्लगइन प्रकार सेट करने के बाद, आप यह सत्यापित करने के लिए अपने कस्टम एपीआई का परीक्षण कर सकते हैं कि सही परिणाम लौटाए गए हैं।

कस्टम एपीआई बनाने के अन्य तरीके

प्लगइन पंजीकरण उपकरण एक कस्टम एपीआई डिजाइनर प्रदान करता है। अधिक जानकारी के लिए, प्लग-इन पंजीकरण टूल का उपयोग करके एक कस्टम API बनाएँ देखें.

आपके पास एक क्लाइंट एप्लिकेशन बनाने की आवश्यकताएं हो सकती हैं जो डिज़ाइनर के बाहर कस्टम एपीआई बनाने की अनुमति देता है। चूंकि कस्टम API के लिए डेटा तालिकाओं में संग्रहीत किया जाता है, इसलिए आप उन्हें कोड का उपयोग करके बना सकते हैं. अधिक जानकारी के लिए, कोड के साथ एक कस्टम API बनाएं देखें.

समाधान फ़ाइलों को संपादित करके कस्टम एपीआई बनाकर आपकी एएलएम प्रक्रिया को बेहतर ढंग से पूरा किया जा सकता है। अधिक जानकारी के लिए, समाधान फ़ाइलों के साथ एक कस्टम API बनाएँ देखें.

इसे भी देखें

कस्टम API बनाएं और उनका उपयोग करें
प्लग-इन पंजीकरण टूल का उपयोग करके एक कस्टम एपीआई बनाएं
कोड के साथ एक कस्टम एपीआई बनाएं
समाधान फ़ाइलों के साथ एक कस्टम API बनाएं
अपने स्वयं के संदेश बनाएं