Порталдар веб 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 қоңыраулары анонимді пайдаланушы мүмкіндігін санау кезінде есептеледі. Аутентификацияланған пайдаланушылар жасаған (ішкі немесе сыртқы) веб-API қоңыраулары бет қарауларында есептелмейді, бірақ тиісті аутентификацияланған пайдаланушы мүмкіндігі лицензияларын қажет етеді. Қосымша ақпарат: Power Pages бағдарламасын лицензиялау бойынша ЖҚС
Веб-API операциялары
Порталдардың веб-API интерфейсі Dataverse әрекеттерінің мүмкіндіктер жиынын ұсынады және оны Dataverse API интерфейсін пайдалану арқылы жасауға болады. Оқу қисығын азайту үшін біз API пішімін мүмкіндігінше ұқсас етіп ұстадық.
Ескертпе
Веб- API операциялары регистрге тәуелді.
Power Pages жүйесінде қолжетімді веб-API операциялары
- Кестеден жазбаларды оқу
- Кестеде жазба жасау
- Кестедегі жазбаларды жаңарту және жою
- Кестелерді біріктіру және ажырату
Ескертпе
Порталдардың Веб-API интерфейсін пайдалану арқылы қоңырау шалу әрекеттері мен функцияларына қолдау көрсетілмейді.
Веб API сайт параметрлері
Портал үшін веб-API интерфейсін қосу үшін сайт параметрін қосу керек. Сондай-ақ сіз порталдардың веб‑API интерфейстерімен өзгертуге болатын немесе болмайтын кесте өрістерін анықтайтын өріс деңгейіндегі Веб-API интерфейсін конфигурациялай аласыз.
Ескертпе
Осы параметрлер үшін логикалық атау кестесін пайдаланыңыз (мысалы тіркелгі).
Сайт параметрі аты | Сипаттама |
---|---|
Webapi/<кесте аты>/enabled | <кесте аты> үшін веб-API интерфейсін қосады немесе өшіреді. Әдепкі: False Жарамды мәндер: True , False |
Webapi/<кесте аты>/fields | Веб API көмегімен өзгертуге болатын атрибуттардың үтірмен бөлінген тізімін анықтайды. Ықтимал мәндер: - Барлық атрибут: * - Ерекше атрибуттар: attr1,attr2,attr3 Ескертпе: мән жұлдызшамен (*) немесе үтірмен бөлінген өрістер атауларының тізімі болуы керек. Маңызды: бұл сайттың міндетті параметрі. Бұл параметр жоқ болғанда, сіз "Бұл нысан үшін өрістер анықталмаған" қатесін көресіз. |
Webapi/error/innererror | Ішкі қатені қосады немесе өшіреді. Әдепкі: False Жарамды мәндер: True , False |
Webapi/<кесте аты>/disableodatafilter | OData сүзгісін қосады немесе өшіреді. Әдепкі: False Жарамды мәндер: True , False Қосымша ақпаратты белгілі мәселелерден қараңыз. Сайт параметрі порталдың 9.4.10.74 немесе кейінгі нұсқаларында қолжетімді. |
Ескертпе
Торап параметрлері өзгерістер күшіне енуі үшін Белсенді болуы керек.
Мысалы, осы нысанда аутентификацияланған пайдаланушыларға операцияларды жасауға, жаңартуға және жоюға рұқсат берілген іс кестесіне арналған веб‑API интерфейсін көрсету үшін сайт параметрлері келесі кестеде көрсетілген.
Сайт параметрі аты | Сайт параметрінің мәні |
---|---|
Webapi/incident/enabled | шынайы |
Webapi/incident/fields | attr1, attr2, attr3 |
Веб API порталдарымен қауіпсіздік
Кесте рұқсаттарын пайдалану арқылы жазбаға негізделген қауіпсіздікті порталдардағы жеке жазбаларға конфигурациялауға болады. Порталдарың веб‑API интерфейсі кесте (нысан) жазбаларына қатынасады және пайдаланушыларға байланысты веб-рөл арқылы берілген кесте рұқсаттарын орындайды.
Порталдардың Веб-API интерфейсін пайдалану кезінде кестедегі жеке бағандар үшін артықшылықтарды одан әрі анықтау үшін баған рұқсаттарын реттеуіңізге болады,
Порталдардың веб-API сұрауларының аутентификациясы
Аутентификация кодын енгізу қажет емес, өйткені аутентификация мен авторизацияны бағдарлама сеансы басқарады. Барлық веб-API қоңыраулары сайттар арасындағы сұраулар жасау (CSRF) таңбалауышын қамтуы керек.
EntitySetName пайдалану
Кодыңыздағы порталдардың Веб-API интерфейсін пайдаланатын Dataverse кестелер үшін EntitySetName параметрін пайдалануыңыз қажет, мысалы, тіркелгі кестесіне қатынасу үшін код синтаксисі тіркелгілер;/_api/accounts()
ішіндегі EntitySetName параметрін пайдаланады.
Ескертпе
Сайт параметрлері үшін кестенің логикалық атауын пайдаланыңыз (мысалы, account).
Келесі қадамдарды орындау арқылы арнайы кестелердің EntitySetName параметрін анықтай аласыз:
Бүйірлік тақтадан Dataverse қойыншасын басып, кестені таңдаңыз.
... (пәрмендер опциясы) мәзірін таңдап, содан кейін кестенің EntitySetName сипатын аралық сақтағышқа көшіру үшін, Кеңейтілген, Құралдар және Жинақ атауын көшіру опциясын таңдаңыз.
Құпиялық туралы заңдар мен ережелер
Сұраудың барлық тақырыптарында тексеру мақсаттары үшін берілген контакт идентификаторы болады. Анонимді пайдаланушы үшін бұл келесі түрде беріледі: 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
Белгілі мәселелер
Пайдаланушылар GET
Web API сұрауын 1-ден көп немесе көптен көпкесте рұқсаттары қашан Ата-ана, Байланыс немесе Тіркелгі аумақтары сұрауға қосымша шарттарды қосады.
Бұл мәселені шешу үшін, ұсынылған шешім OData сұрауында FetchXML параметрін пайдалану болып табылады.
Болмаса, Webapi/<кесте аты>/disableodatafilter сайт параметрін True
күйіне орнатыңыз.
Маңызды
Webapi/<table name>/disableodatafilter сайт параметрін True
күйіне өзгерту веб-API GET
қоңырауларының баяуырақ өнімділігіне әкелуі мүмкін.
Сайт параметрі порталдың 9.4.10.74 немесе кейінгі нұсқаларында қолжетімді.
Келесі қадам
Порталдардың Веб-API интерфейсі арқылы деректерді сұрау