पोर्टल वेब API अवलोकन

नोट

12 अक्टूबर 2022 से प्रभावी, Power Apps पोर्टल Power Pages है। अधिक जानकारी: Microsoft Power Pages अब आम तौर पर उपलब्ध है (ब्लॉग)
हम जल्द ही Power Apps पोर्टल दस्तावेज़ीकरण को Power Pages दस्तावेज़ीकरण के साथ माइग्रेट और विलय करेंगे।

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

नोट

आप Power Pages में पोर्टल वेब एपीआई का भी उपयोग कर सकते हैं. अधिक जानकारी: Power Pages क्या है

महत्वपूर्ण

• इस फ़ीचर के काम करने के लिए आपका पोर्टल संस्करण 9.3.3.x या बाद का होना चाहिए.
• पोर्टल पेज के अंदर एक समृद्ध उपयोगकर्ता अनुभव बनाने के लिए पोर्टल वेब API बनाया गया है. यह तृतीय-पक्ष सेवाओं या अनुप्रयोग एकीकरण के लिए ऑप्टिमाइज़ नहीं है. अन्य Power Apps पोर्टल साइटों के साथ एकीकृत करने के लिए पोर्टल्स वेब एपीआई का उपयोग करना भी समर्थित नहीं है.
• Portals Web API संक्रियाएं, डेटा से संबंधित टेबलों तक सीमित होती हैं—उदाहरण के लिए, अकाउंट, संपर्क, या आपकी कस्टम टेबल. टेबल मेटाडेटा या पोर्टल कॉन्फ़िगरेशन टेबल डेटा को कॉन्फ़िगर करना—उदाहरण के लिए, पोर्टल टेबल, जैसे कि, adx_contentsnippet, adx_entityform, अथवा adx_entitylist—पोर्टल्स Web API के साथ समर्थित नहीं होती है. पूरी सूची के लिए, इस विषय में बाद में अमर्थित कॉन्फ़िगरेशन टेबल पर जाएं.
• पोर्टल वेब API का लाभ है सर्वर-साइड कैशिंग से होता है और इसलिए, वेब API के बाद के कॉल शुरुआती कॉल की तुलना में तेज होते हैं. ध्यान दें कि पोर्टल सर्वर-साइड कैश को साफ़ करने से प्रदर्शन में अस्थायी गिरावट आती है.
• पोर्टल Web API परिचालनों के लिए Power Apps पोर्टल लाइसेंस की आवश्यकता है. उदाहरण के लिए, अनाम उपयोगकर्ताओं द्वारा की गई Web API कॉल को पृष्ठ दृश्य क्षमता की ओर गिना जाता है. प्रमाणित उपयोगकर्ताओं (आंतरिक या बाहरी) द्वारा किए गए Web API कॉल को पृष्ठ दृश्यों के लिए नहीं गिना जाता है, लेकिन इसके लिए लाइसेंस की आवश्यकता होती है. अधिक जानकारी: Power Apps पोर्टल लाइसेंसिंग अक्सर पूछे जाने वाले प्रश्न

वेब API कार्रवाइयाँ

पोर्टल वेब API Dataverse संचालन के लिए क्षमताओं का एक सबसेट प्रदान करता है, जिसे आप Dataverse API का उपयोग करके कर सकते हैं. हमने सीखने की अवस्था को कम करने के लिए API प्रारूप को यथासंभव समान रखा है.

नोट

वेब API संचालन केस-संवेदी होते हैं.

वेब API संचालन पोर्टल्स में उपलब्ध है

• तालिका से रिकॉर्ड पढ़ें
• एक टैबल में एक रिकॉर्ड बनाएं
• एक तालिका में रिकॉर्ड अपडेट करें और हटाएं
• टेबल संबद्ध और असंबद्ध करें

नोट

पोर्टल्स वेब एपीआई का उपयोग करके कार्रवाई तथा कार्यों को कॉल करना समर्थित नहीं है.

वेब API के लिए साइट सेटिंग्स

आपको अपने पोर्टल के लिए पोर्टल वेब API को सक्षम करने के लिए साइट सेटिंग को सक्षम करना होगा. साथ ही, आप फ़ील्ड-स्तरीय Web API को भी कॉन्फ़िगर कर सकते हैं जो उन टेबल फ़ील्ड को निर्धारित करता है जिन्हें पोर्टल्स Web API के साथ संशोधित किया जा सकता है अथवा नहीं किया जा सकता है.

नोट

इन सेटिंग्स के लिए तालिका तार्किक नाम इका उपयोग करें (उदाहरण के लिए खाता).

साइट सेटिंग नाम	विवरण
Webapi/<table name>/enabled	वेब API को <table name>के लिए सक्षम या अक्षम करता है। डिफ़ॉल्ट: False वैलिड वैल्यूज़: True, False
Webapi/<table name>/fields	वेब API के साथ संशोधित की जा सकने वाली विशेषताओं की अल्पविराम से अलग की गई सूची को परिभाषित करता है. संभावित मान: - सभी एट्रिब्यूट: * - विशिष्ट एट्रिब्यूट: attr1,attr2,attr3 नोट: मान या तो तारांकन चिह्न (*) या फ़ील्ड नामों की अल्पविराम से अलग की गई सूची में होना चाहिए. महत्वपूर्ण: यह अनिवार्य साइट सेटिंग है. जब यह सेटिंग गुम हो जाती है, तो आपको "इस निकाय के लिए कोई फ़ील्ड निर्धारित नहीं की गई" त्रुटि दिखाई देगी.
Webapi/error/innererror	आंतरिक सूचि को सक्षम या अक्षम करता है. डिफ़ॉल्ट: False वैलिड वैल्यूज़: True, False
Webapi/<table name>/disableodatafilter	OData फ़िल्टर को सक्षम या अक्षम करता है. डिफ़ॉल्ट: False मान्य मान: True, False अधिक जानकारी के लिए ज्ञात मुद्दे देखें. साइट सेटिंग पोर्टल संस्करण 9.4.10.74 या इसके बाद के संस्करण में उपलब्ध है.

नोट

परिवर्तन करने के लिए साइट सेटिंग्स को सक्रिय पर सेट किया जाना चाहिए.

उदाहरण के लिए, केस टेबल के लिए Web API को प्रकट करने के लिए, जहां प्रमाणित उपयोगकर्ताओं को इस निकाय पर बनाने, अपडेट करने और हटाने की संक्रियाओं की अनुमति होती है, उनकी साइट सेटिंग्स को नीचे दी गई टेबल में दिखाया गया है.

साइट सेटिंग नाम	साइट सेटिंग मान
Webapi/incident/enabled	true
Webapi/incident/fields	attr1, attr2, attr3

पोर्टल वेब API के साथ सुरक्षा

आप टेबल अनुमतियां का उपयोग करके रिकॉर्ड-आधारित सुरक्षा को पोर्टल में अलग-अलग रिकॉर्ड में कॉन्फ़िगर कर सकते हैं. पोर्टल्स वेब एपीआई तालिका (निकाय) रिकॉर्ड तक पहुंचता है और संबंधित वेब भूमिका के माध्यम से उपयोगकर्ताओं को दी गई तालिका अनुमतियों का पालन करता है.

आप पोर्टल्स वेब एपीआई का उपयोग करते समय तालिका के भीतर अलग-अलग कॉलमों के लिए विशेषाधिकारों को और परिभाषित करने के लिए कॉलम अनुमतियां कॉन्फ़िगर कर सकते हैं.

पोर्टल्स वेब API अनुरोधों को प्रमाणित करना

आपको प्रमाणीकरण कोड शामिल करने की ज़रूरत नहीं है, क्योंकि प्रमाणीकरण और प्राधिकरण अनुप्रयोग सत्र द्वारा प्रबंधित किए जाते हैं. सभी वेब API कॉल में Cross-Site Request Forgery (CSRF) टोकन शामिल होना चाहिए.

EntitySetName का उपयोग करना

अपने कोड में पोर्टल्स वेब एपीआई का उपयोग करते हुए Dataverse तालिकाओं का संदर्भ देते समय, आपको EntitySetName का उपयोग करने की आवश्यकता होती है, उदाहरण के लिए खाता तालिका तक पहुँचने के लिए, कोड सिंटैक्स खाता के EntitySetName का उपयोग करेगा ; /_api/accounts().

नोट

साइट सेटिंग के लिए तालिका तार्किक नाम का उपयोग करें (उदाहरण के लिए, खाता).

आप इन चरणों का पालन करके विशिष्ट तालिकाओं का EntitySetName निर्धारित कर सकते हैं:

1. https://make.powerapps.com पर जाएँ

2. साइड पैनल से Dataverse टैब चुनें और टेबल चुनें.

3. तालिका के EntitySetName को अपने क्लिपबोर्ड पर कॉपी करने के लिए ... (कमांड विकल्प) चुनें और फिर विकसित, टूल्स, और सेट का नाम कॉपी करें चुनें.

   

सामान्य डेटा सुरक्षा विनियम (GDPR)

सभी अनुरोध हेडर के पास ऑडिटिंग प्रयोजन के लिए एक संपर्क ID पारित की गई होगी. एक अनाम उपयोगकर्ता के लिए, इसे nullnull' के रूप में पारित किया जाएगा.

यदि ऑडिट लॉगिंग सक्षम है, तो एक उपयोगकर्ता Office 365 ऑडिट लॉग में सभी ऑडिट इवेंट देख सकता है.

और जानकारी:
गतिविधि लॉगिंग सक्षम करें और उपयोग करें
निर्यात करें, कॉन्फ़िगर करें और ऑडिट लॉग रिकॉर्ड देखें

असमर्थित कॉन्फ़िगरेशन टेबल

निम्नलिखत कॉन्फ़िगरेशन टेबलों के लिए पोर्टल्स Web API का उपयोग नहीं किया जा सकता है:

adx_contentaccesslevel

adx_contentsnippet

adx_entityform

adx_entityformmetadata

adx_entitylist

adx_entitypermission

adx_entitypermission_webrole

adx_externalidentity

adx_pagealert

adx_pagenotification

adx_pagetag

adx_pagetag_webpage

adx_pagetemplate

adx_portallanguage

adx_publishingstate

adx_publishingstatetransitionrule

adx_publishingstatetransitionrule_webrole

adx_redirect

adx_settings

adx_shortcut

adx_sitemarker

adx_sitesetting

adx_urlhistory

adx_webfile

adx_webfilelog

adx_webform

adx_webformmetadata

adx_webformsession

adx_webformstep

adx_weblink

adx_weblinkset

adx_webnotificationentity

adx_webnotificationurl

adx_webpage

adx_webpage_tag

adx_webpageaccesscontrolrule

adx_webpageaccesscontrolrule_webrole

adx_webpagehistory

adx_webpagelog

adx_webrole_systemuser

adx_website

adx_website_list

adx_website_sponsor

adx_websiteaccess

adx_websiteaccess_webrole

adx_websitebinding

adx_websitelanguage

adx_webtemplate

ज्ञात समस्याएँ

उपयोगकर्ताओं को एक सीडीएस त्रुटि मिलेगी यदि वे तालिकाओं के लिए GET वेब एपीआई अनुरोध का आह्वान करते हैं जिसमें 1 से कई या कई से कई टेबल अनुमतियां के कई स्तर पैरेंट परिभाषित दायरे के साथ हैं.

इस समस्या को हल करने के लिए, अनुशंसित समाधान OData क्वेरी में FetchXML का उपयोग करना है.

वैकल्पिक रूप से, साइट सेटिंग सेट Webapi/<table name>/disableodatafilter को True पर सेट करें.

महत्वपूर्ण

साइट सेटिंग Webapi/<table name>/disableodatafilter को True में बदलने से वेब API GET कॉलों का प्रदर्शन धीमा हो सकता है.

साइट सेटिंग पोर्टल संस्करण 9.4.10.74 या इसके बाद के संस्करण में उपलब्ध है.

अगला कदम

पोर्टल्स वेब API का उपयोग कर क्वेरी डेटा

भी देखें

HTTP अनुरोधों को लिखें और त्रुटियों को संभालें
पोर्टल वेब API का उपयोग करके संचालन लिखते हैं, अपडेट करते हैं और हटाते हैं
ट्यूटोरियल: पोर्टल वेब API का उपयोग करें

नोट

क्या आप हमें अपनी दस्तावेज़ीकरण भाषा वरीयताओं के बारे में बता सकते हैं? एक छोटा सर्वेक्षण पूरा करें. (कृपया ध्यान दें कि यह सर्वेक्षण अंग्रेज़ी में है)

सर्वेक्षण में लगभग सात मिनट लगेंगे. कोई भी व्यक्तिगत डेटा एकत्र नहीं किया जाता है (गोपनीयता कथन).