Бөлісу құралы:

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

  • Мақала

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

Маңызды

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

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

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

Ескертпе

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

Power Pages жүйесінде қолжетімді веб-API операциялары

Ескертпе

Web API порталдарын пайдалану арқылы әрекеттерге және функцияларға қолдау көрсетілмейді.

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

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

Ескертпе

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

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

Ескертпе

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

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

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

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

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

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

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

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

EntitySetName пайдалану

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

Ескертпе

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

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

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

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

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

    Dataverse кестесінің EntitySetName сипатын табу жолы.

Құпиялық туралы заңдар мен ережелер

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

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

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

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

Пайдаланушылар GET 1-ден көп немесе Web API сұрауын шақырса, CDS қатесін алады. >көптен көпкекесте рұқсаттар қашан Ата-ана, **Байланыс немесе Есептік жазба аумақтар сұрауға қосымша шарттарды қосады.

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

Болмаса, Webapi/<кесте аты>/disableodatafilter сайт параметрін True күйіне орнатыңыз.

Маңызды

Сайт параметрін Webapi/<кесте атауы>/disableodatafilterTrue деп өзгерту баяулауына әкелуі мүмкін Web API GET қоңыраулары үшін өнімділік.

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

Келесі қадам

Web API порталдары арқылы деректерді сұрау