Порталдар веб API шолуы

Ескерім

2022 жылдың 12 қазанынан бастап күшіне енеді, Power Apps порталдары — Power Pages. Қосымша ақпарат: Microsoft Power Pages енді жалпыға қолжетімді (блог)
Жақында Power Apps порталдары құжаттамасын Power Pages құжаттамасымен көшіреміз және біріктіреміз.

Порталдардың веб-API интерфейсі Power Apps порталдар беттерінде кеңейтілген пайдаланушы интерфейсін жасауға мүмкіндік береді. Веб‑API интерфейсін порталдар беттеріндегі барлық Microsoft Dataverse кестелері бойынша жасау, оқу, жаңарту және жою операцияларына орындау үшін пайдалануға болады. Мысалы, сіз порталды басқару бағдарламасының орнына веб‑API интерфейсін пайдалану арқылы өнім үшін жаңа тіркелгі жасап, контактіні жаңартып немесе кесте рұқсаттарын өзгерте аласыз.

Ескерім

Сондай-ақ Power Pages бағдарламасында порталдардың веб-API интерфейсін пайдалануға болады. Қосымша ақпарат: Power Pages деген не?

Маңызды

• Бұл мүмкіндіктің жұмыс істеуі үшін сіздің порталыңыздың нұсқасы 9.3.3.x немесе одан кейінгі нұсқа болуы керек.
• Порталдардың веб-API интерфейсі портал беттерінде бай пайдаланушы тәжірибесін жасау үшін құрылады. Бұл үшінші тарап қызметтері немесе бағдарламаларын біріктіру үшін оңтайландырылмаған. Басқа Power Apps порталдарының сайттарымен біріктіру үшін порталдардың Веб-API интерфейсін пайдалануға да қолдау көрсетілмейді.
• Порталдардың веб‑API операциялары деректермен байланысты кестелермен шектеледі—мысалы, тіркелгілер, контактілер немесе реттелетін кестелер. Кестенің метадеректерін немесе порталдың конфигурация кестесінің деректерін конфигурациялау—мысалы, adx_contentsnippet, adx_entityform немесе adx_entitylist сияқты портал кестелерін конфигурациялауға—порталдардың веб‑API операцияларымен қолдау көрсетілмейді. Толық тізімді алу үшін кейінірек осы тақырыптағы қолдау көрсетілмейтін конфигурация кестелері бөліміне өтіңіз.
• Порталдардың веб-API интерфейсі сервер тарапындағы кэштеуден артықшылыққа ие болады, демек, Веб-API кейінгі қоңыраулары алғашқы қоңырауларға қарағанда жылдамырақ болады. Порталдың серверлік кэшін тазарту өнімділіктің уақытша нашарлауына әкелетінін ескеріңіз.
• Порталдардың веб-API операциялары Power Apps порталдар лицензиясын қажет етеді. Мысалы, анонимді пайдаланушылар жасаған веб-API қоңыраулары бет қарауларын санау кезінде есептеледі. Түпнұсқалығы расталған пайдаланушылар жасаған (ішкі немесе сыртқы) веб-API қоңыраулары бет қарауларында есептелмейді, бірақ тиісті лицензияларды қажет етеді. Қосымша ақпарат: Power Apps лицензиялауы туралы жиі қойылатын сұрақтар

Веб-API операциялары

Порталдардың веб-API интерфейсі Dataverse әрекеттерінің мүмкіндіктер жиынын ұсынады және оны Dataverse API интерфейсін пайдалану арқылы жасауға болады. Оқу қисығын азайту үшін біз API пішімін мүмкіндігінше ұқсас етіп ұстадық.

Ескерім

Веб- API операциялары регистрге тәуелді.

Веб-API операциялары порталдарда қолжетімді

• Кестеден жазбаларды оқу
• Кестеде жазба жасау
• Кестедегі жазбаларды жаңарту және жою
• Кестелерді біріктіру және ажырату

Ескерім

Порталдардың Веб-API интерфейсін пайдалану арқылы қоңырау шалу әрекеттері мен функцияларына қолдау көрсетілмейді.

Веб API сайт параметрлері

Портал үшін веб-API интерфейсін қосу үшін сайт параметрін қосу керек. Сондай-ақ сіз порталдардың веб‑API интерфейстерімен өзгертуге болатын немесе болмайтын кесте өрістерін анықтайтын өріс деңгейіндегі Веб-API интерфейсін конфигурациялай аласыз.

Ескерім

Осы параметрлер үшін логикалық атау кестесін пайдаланыңыз (мысалы тіркелгі).

Сайт параметрі аты	Сипаттама
Webapi/<table name>/қосылған	<table name> үшін веб-API интерфейсін қосады немесе өшіреді. Әдепкі: False Жарамды мәндер: True, False
Webapi/<table name>/өрістер	Веб API көмегімен өзгертуге болатын атрибуттардың үтірмен бөлінген тізімін анықтайды. Ықтимал мәндер: - Барлық төлсипаттар: * - Ерекше төлсипаттар: attr1,attr2,attr3 Ескерту: мән жұлдызшамен (*) немесе үтірмен бөлінген өрістер атауларының тізімі болуы керек. Маңызды: бұл сайттың міндетті параметрі. Бұл параметр жоқ болғанда, сіз "Бұл нысан үшін өрістер анықталмаған" қатесін көресіз.
Webapi/error/innererror	Ішкі қатені қосады немесе өшіреді. Әдепкі: False Жарамды мәндер: True, False
Webapi/<table name>/disableodatafilter	OData сүзгісін қосады немесе өшіреді. Әдепкі: False Жарамды мәндер: True, False Қосымша ақпарат алу үшін, белгілі мәселелер бөлімін қараңыз. Сайт параметрі порталдың 9.4.10.74 немесе кейінгі нұсқаларында қолжетімді.

Ескерім

Торап параметрлері өзгерістер күшіне енуі үшін Белсенді болуы керек.

Мысалы, осы нысанда аутентификацияланған пайдаланушыларға операцияларды жасауға, жаңартуға және жоюға рұқсат берілген іс кестесіне арналған веб‑API интерфейсін көрсету үшін сайт параметрлері келесі кестеде көрсетілген.

Сайт параметрі аты	Сайт параметрінің мәні
Webapi/инцидент/қосылған	шынайы
Webapi/инцидент/өрістер	attr1, attr2, attr3

Веб API порталдарымен қауіпсіздік

Кесте рұқсаттарын пайдалану арқылы жазбаға негізделген қауіпсіздікті порталдардағы жеке жазбаларға конфигурациялауға болады. Порталдарың веб‑API интерфейсі кесте (нысан) жазбаларына қатынасады және пайдаланушыларға байланысты веб-рөл арқылы берілген кесте рұқсаттарын орындайды.

Порталдардың Веб-API интерфейсін пайдалану кезінде кестедегі жеке бағандар үшін артықшылықтарды одан әрі анықтау үшін баған рұқсаттарын реттеуіңізге болады,

Порталдардың веб-API сұрауларының аутентификациясы

Аутентификация кодын енгізу қажет емес, өйткені аутентификация мен авторизацияны бағдарлама сеансы басқарады. Барлық веб-API қоңыраулары сайттар арасындағы сұраулар жасау (CSRF) таңбалауышын қамтуы керек.

EntitySetName пайдалану

Кодыңыздағы порталдардың Веб-API интерфейсін пайдаланатын Dataverse кестелер үшін EntitySetName параметрін пайдалануыңыз қажет, мысалы, тіркелгі кестесіне қатынасу үшін код синтаксисі тіркелгілер;/_api/accounts() ішіндегі EntitySetName параметрін пайдаланады.

Ескерім

Сайт параметрлері үшін кестенің логикалық атауын пайдаланыңыз (мысалы, account).

Келесі қадамдарды орындау арқылы арнайы кестелердің EntitySetName параметрін анықтай аласыз:

1. https://make.powerapps.com өту

2. Бүйірлік тақтадан Dataverse қойыншасын басып, кестені таңдаңыз.

3. ... (пәрмендер опциясы) мәзірін таңдап, содан кейін кестенің EntitySetName сипатын аралық сақтағышқа көшіру үшін, Кеңейтілген, Құралдар және Жинақ атауын көшіру опциясын таңдаңыз.

   

Жалпы деректерді қорғау регламенті (GDPR)

Сұраудың барлық тақырыптарында тексеру мақсаттары үшін берілген контакт идентификаторы болады. Анонимді пайдаланушы үшін бұл келесі түрде беріледі: null.

Егер тексеру журналы қосылса, пайдаланушы барлық тексеру оқиғаларын Office 365 тексеру журналында көре алады.

Қосымша ақпарат:
Әрекет журналын жүргізуді қосу және пайдалану
Тексеру журналы жазбаларын экспорттау, конфигурациялау және қарау

Қолдау көрсетілмейтін конфигурация кестелері

Порталдардың веб‑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_setting

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

Белгілі мәселелер

Пайдаланушылар анықталған parent ауқымы бар 1-ден көпке немесе көптен көпке кесте рұқсаттарының бірнеше деңгейі бар кестелерге арналған GET веб-API сұрауын шақырса, олар CDS қатесін алады.

Бұл мәселені шешу үшін, ұсынылған шешім OData сұрауында FetchXML параметрін пайдалану болып табылады.

Болмаса Webapi/<table name>/disableodatafilter сайт параметрін True мәніне орнатыңыз.

Маңызды

Webapi/<table name>/disableodatafilter сайт параметрін True мәніне өзгерту Веб-API GET қоңыраулары үшін баяу өнімділікке әкелуі мүмкін.

Сайт параметрі порталдың 9.4.10.74 немесе кейінгі нұсқаларында қолжетімді.

Келесі қадам

Порталдардың Веб-API интерфейсі арқылы деректерді сұрау

Сонымен қатар қараңыз

HTTP сұрауларын құрастыру және қателерді өңдеу
Порталдардағы веб-API арқылы жазу, жаңарту және жою операциялары
Оқулық: порталдың веб-API интерфейсін пайдалану

Ескерім

Сіз құжат тіліңіздің артықшылықтары туралы айта аласыз ба? Қысқа сауалнамаға қатысыңыз. (бұл сауалнама ағылшын тілінде екеніне назар аударыңыз)

Сауалнама шамамен жеті минут уақытыңызды алады. Жеке деректер жиналмайды (құпиялылық туралы мәлімдеме).