पोर्टल वेब API अवलोकन
पोर्टल Web API Power Pages साइट्स के अंदर एक समृद्ध उपयोगकर्ता अनुभव को सक्षम बनाता है. आप अपने वेबपेजों से सभी Microsoft Dataverse तालिकाओं में बनाने, पढ़ने, अपडेट करने और संचालन को हटाने के लिए Web API का उपयोग कर सकते हैं. उदाहरण के लिए, आप पोर्टल Web API का उपयोग करके प्रपत्र या मल्टीस्टेप प्रपत्र का उपयोग किए बिना एक नया खाता बना सकते हैं, संपर्क अपडेट कर सकते हैं.
महत्त्वपूर्ण
- इस सुविधा के काम करने के लिए आपकी साइट का संस्करण 9.3.3.x या बाद का होना चाहिए। Power Pages
- पोर्टल पेज के अंदर एक समृद्ध उपयोगकर्ता अनुभव बनाने के लिए पोर्टल वेब API बनाया गया है. यह तृतीय-पक्ष सेवाओं या अनुप्रयोग एकीकरण के लिए ऑप्टिमाइज़ नहीं है. अन्य Power Pages साइटों के साथ एकीकृत करने के लिए पोर्टल Web API का उपयोग भी समर्थित नहीं है.
- Portals Web API संक्रियाएं, डेटा से संबंधित टेबलों तक सीमित होती हैं - उदाहरण के लिए, अकाउंट, संपर्क, या आपकी कस्टम टेबल. टेबल मेटाडेटा या पोर्टल कॉन्फ़िगरेशन टेबल डेटा को कॉन्फ़िगर करना - उदाहरण के लिए, पोर्टल टेबल, जैसे कि, adx_contentsnippet, adx_entityform, अथवा adx_entitylist - पोर्टल्स Web API के साथ समर्थित नहीं होती है. पूरी सूची के लिए, इस आलेख में बाद में असमर्थित कॉन्फ़िगरेशन तालिकाएँ पर जाएँ।
- पोर्टल वेब API का लाभ है सर्वर-साइड कैशिंग से होता है और इसलिए, वेब API के बाद के कॉल शुरुआती कॉल की तुलना में तेज होते हैं. पोर्टल सर्वर-साइड कैश को साफ़ करने से अस्थायी रूप से प्रदर्शन में गिरावट आती है।
- पोर्टल Web API परिचालनों के लिए Power Pages लाइसेंस की आवश्यकता है. उदाहरण के लिए, अनाम उपयोगकर्ताओं द्वारा की गई Web API कॉल को अनाम उपयोगकर्ता क्षमता में गिना जाता है. प्रमाणीकृत उपयोगकर्ताओं (आंतरिक या बाह्य) द्वारा किए गए वेब API कॉल को पृष्ठ दृश्यों में नहीं गिना जाता है, लेकिन इसके लिए लागू प्रमाणीकृत उपयोगकर्ता क्षमता लाइसेंस की आवश्यकता होती है। अधिक जानकारी: Power Pages लाइसेंसिंग के लिए अक्सर पूछे जाने वाले प्रश्न
वेब API कार्रवाइयाँ
पोर्टल वेब API Dataverse संचालन के लिए क्षमताओं का एक सबसेट प्रदान करता है, जिसे आप Dataverse API का उपयोग करके कर सकते हैं. हमने सीखने की प्रक्रिया को कम करने के लिए API प्रारूप को यथासंभव समान रखा।
नोट
वेब API संचालन केस-संवेदी होते हैं.
Web API संचालन, Power Pages में उपलब्ध हैं
- किसी तालिका से रिकॉर्ड पढ़ें
- तालिका में रिकॉर्ड बनाएँ
- तालिका में रिकॉर्ड अपडेट करें और हटाएं
- तालिकाओं को संबद्ध और असंबद्ध करें
वेब API के लिए साइट सेटिंग्स
आपको अपने पोर्टल के लिए पोर्टल वेब API को सक्षम करने के लिए साइट सेटिंग को सक्षम करना होगा. साथ ही, आप फ़ील्ड-स्तरीय Web API को भी कॉन्फ़िगर कर सकते हैं जो उन टेबल फ़ील्ड को निर्धारित करता है जिन्हें पोर्टल्स Web API के साथ संशोधित किया जा सकता है अथवा नहीं किया जा सकता है.
नोट
इन सेटिंग्स के लिए तालिका तार्किक नाम इका उपयोग करें (उदाहरण के लिए खाता).
| साइट सेटिंग नाम | विवरण |
|---|---|
| Webapi/<तालिका नाम>/सक्षम | Web API को <तालिका नाम> के लिए सक्षम या अक्षम करता है. गलती करना: False मान्य मान: True, False |
| Webapi/<तालिका नाम>/फ़ील्ड | वेब API के साथ संशोधित की जा सकने वाली विशेषताओं की अल्पविराम से अलग की गई सूची को परिभाषित करता है. संभावित मान: - सभी विशेषताएँ: * - विशिष्ट विशेषताएँ: attr1,attr2,attr3 नोट: मान या तो तारांकन चिह्न (*) या फ़ील्ड नामों की अल्पविराम से अलग की गई सूची होनी चाहिए. महत्वपूर्ण: यह सेटिंग एक अनिवार्य साइट सेटिंग है. जब यह सेटिंग अनुपलब्ध होती है, तो आपको "इस इकाई के लिए कोई फ़ील्ड परिभाषित नहीं है" त्रुटि दिखाई देती है. |
| वेबएपीआई/त्रुटि/आंतरिकत्रुटि | आंतरिक सूचि को सक्षम या अक्षम करता है. गलती करना: False मान्य मान: True, False |
| Webapi/<टेबल नाम>/disableodatafilter | OData फ़िल्टर को सक्षम या अक्षम करता है. गलती करना: False मान्य मान: True, False अधिक जानकारी के लिए ज्ञात समस्याएँ देखें. साइट सेटिंग पोर्टल संस्करण 9.4.10.74 या इसके बाद के संस्करण में उपलब्ध है. |
नोट
परिवर्तन करने के लिए साइट सेटिंग्स को सक्रिय पर सेट किया जाना चाहिए.
उदाहरण के लिए, केस टेबल के लिए Web API को प्रकट करने के लिए, जहां प्रमाणित उपयोगकर्ताओं को इस निकाय पर बनाने, अपडेट करने और हटाने की संक्रियाओं की अनुमति होती है, उनकी साइट सेटिंग्स को नीचे दी गई टेबल में दिखाया गया है.
| साइट सेटिंग नाम | साइट सेटिंग मान |
|---|---|
| वेबएपीआई/घटना/सक्षम | true |
| वेबएपीआई/घटना/क्षेत्र | attr1, attr2, attr3 |
पोर्टल वेब API के साथ सुरक्षा
आप टेबल अनुमतियां का उपयोग करके रिकॉर्ड-आधारित सुरक्षा को पोर्टल में अलग-अलग रिकॉर्ड में कॉन्फ़िगर कर सकते हैं. पोर्टल्स वेब एपीआई तालिका (निकाय) रिकॉर्ड तक पहुंचता है और संबंधित वेब भूमिका के माध्यम से उपयोगकर्ताओं को दी गई तालिका अनुमतियों का पालन करता है.
आप पोर्टल्स वेब एपीआई का उपयोग करते समय तालिका के भीतर अलग-अलग कॉलमों के लिए विशेषाधिकारों को और परिभाषित करने के लिए कॉलम अनुमतियां कॉन्फ़िगर कर सकते हैं.
पोर्टल्स वेब API अनुरोधों को प्रमाणित करना
आपको प्रमाणीकरण कोड शामिल करने की आवश्यकता नहीं है क्योंकि अनुप्रयोग सत्र प्रमाणीकरण और प्राधिकरण का प्रबंधन करता है। सभी वेब API कॉल में Cross-Site Request Forgery (CSRF) टोकन शामिल होना चाहिए.
EntitySetName का उपयोग करना
अपने कोड में पोर्टल्स वेब API का उपयोग करके Dataverse तालिकाओं का संदर्भ देते समय, आपको EntitySetName का उपयोग करने की आवश्यकता होती है, उदाहरण के लिए, खाता तालिका तक पहुँचने के लिए, कोड सिंटैक्स खातों; /_api/accounts() के EntitySetName का उपयोग करता है।
नोट
साइट सेटिंग के लिए तालिका तार्किक नाम का उपयोग करें (उदाहरण के लिए, खाता).
आप इन चरणों का पालन करके विशिष्ट तालिकाओं का EntitySetName निर्धारित कर सकते हैं:
https://make.powerapps.com पर जाएँ
साइड पैनल से Dataverse टैब चुनें और टेबल चुनें.
तालिका के EntitySetName को अपने क्लिपबोर्ड पर कॉपी करने के लिए ... (कमांड विकल्प) चुनें और फिर विकसित, टूल्स, और सेट का नाम कॉपी करें चुनें.
गोपनीयता कानून और नियम
सभी अनुरोध हेडर ऑडिटिंग प्रयोजनों के लिए पारित संपर्क आईडी का उपयोग करते हैं। अनाम उपयोगकर्ता के लिए, यह मान null के रूप में पारित किया जाता है।
यदि ऑडिट लॉगिंग सक्षम है, तो एक उपयोगकर्ता 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 ऐसी तालिकाओं के लिए वेब API अनुरोध लागू करते हैं, जिनमें 1 से अनेक या अनेक से अनेकतालिका अनुमतियों के एकाधिक स्तर होते हैं, तो उन्हें CDS त्रुटि मिलती है जब अभिभावकीय, **संपर्क, या खाता स्कोप क्वेरी में अधिक शर्तें जोड़ते हैं।
इस समस्या को हल करने के लिए, OData क्वेरी में FetchXML का उपयोग करना अनुशंसित समाधान है।
वैकल्पिक रूप से, साइट सेटिंग को Webapi/<तालिका नाम>/disableodatafilter से True पर सेट करें.
महत्त्वपूर्ण
साइट सेटिंग Webapi/<table name>/disableodatafilter को True में बदलने से Web API GET कॉल का प्रदर्शन धीमा हो सकता है।
साइट सेटिंग पोर्टल संस्करण 9.4.10.74 या इसके बाद के संस्करण में उपलब्ध है.
अगला कदम
पोर्टल वेब API का उपयोग करके डेटा क्वेरी करें