Portālu tīmekļa API pārskats
Portāli tīmekļa API ļauj veidot bagātāku lietotāja pieredzi, atrodoties Power Pages vietnēs. Varat izmantot tīmekļa API, lai visās Microsoft Dataverse tabulās savās tīmekļa lapās veiktu izveides, atjaunināšanas un dzēšanas darbības. Piemēram, varat izveidot jaunu uzņēmumu, atjaunināt kontaktpersonu, neizmantojot veidlapu vai vairāku darbību veidlapu, izmantojot portālu tīmekļa API.
Svarīgi
- Lai šis līdzeklis darbotos, vietnes Power Pages versijai ir jābūt 9.3.3.x vai jaunākai.
- Portālu tīmekļa API ir veidots, lai ļautu veidot bagātu lietotāja pieredzi, atrodoties portālu lapās. Tas nav optimizēts trešo pušu pakalpojumiem vai programmu integrācijai. Portālu tīmekļa API izmantošana, lai integrētu ar citām Power Pages vietnēm, arī netiek atbalstīta.
- Portālu tīmekļa API operācijas ir ierobežotas ar tabulām, kas saistītas ar datiem, piemēram, uzņēmumiem, kontaktpersonām vai jūsu pielāgotajām tabulām. Ar portālu tīmekļa API netiek atbalstīta tabulu metadatu vai, piemēram, portāla konfigurācijas tabulas datu konfigurēšana. Lai iegūtu pilnu sarakstu, skatiet neatbalstītās konfigurācijas tabulas tālāk šajā rakstā.
- Portālu tīmekļa API sniedz priekšrocības no servera puses kešatmiņas, tāpēc turpmākās darbības tīmekļa API ir ātrākas par sākotnējām darbībām. Portāla servera puses kešatmiņas notīrīšana izraisa īslaicīgu veiktspējas pasliktināšanos.
- Portālu tīmekļa API operācijām ir nepieciešama Power Pages licence. Piemēram, anonīmu lietotāju veiktie Web API izsaukumi tiek ieskaitīti anonīmo lietotāju noslodzē. Tīmekļa API izsaukumi, ko veikuši autentificēti lietotāji (iekšēji vai ārēji), netiek ieskaitīti lapas skatos, bet tiem ir nepieciešamas piemērojamas autentificētas lietotāju noslodzes licences. Papildinformācija: Power Pages licencēšanas BUJ
Tīmekļa API darbībām
Portālu tīmekļa API piedāvā iespēju apakškopu Dataverse darbībām, ko varat veikt, izmantojot Dataverse API. Mēs saglabājām API formātu pēc iespējas līdzīgāku, lai samazinātu mācīšanās līkni.
Piezīmes
Tīmekļa API operācijas ir reģistrjutīgas.
Power Pages pieejamās tīmekļa API darbības
- Ierakstu lasīšana no tabulas
- Ieraksta izveide tabulā
- Ierakstu atjaunināšana un dzēšana tabulā
- Asociētās un atsaistītās tabulas
Piezīmes
Darbību un funkciju izsaukšana , izmantojot portālu tīmekļa API, netiek atbalstīta.
Tīmekļa API vietnes iestatījumi
Jums ir jāiespējo vietnes iestatījums, lai iespējotu portālu tīmekļa API jūsu portālam. Varat arī konfigurēt lauka līmeņa Tīmekļa API, kas nosaka tabulas laukus, kurus var vai nevar modificēt ar portālu Tīmekļa API.
Piezīmes
Izmantojiet tabulas loģisko nosaukumu šiem iestatījumiem (piemēram, uzņēmums).
| Vietnes iestatījuma nosaukums | Apraksts |
|---|---|
| Webapi/<tabulas nosaukums>/iespējots | Iespējo vai atspējo tīmekļa API <tabulas nosaukumam>. Noklusējuma: False Derīgas vērtības: TrueFalse |
| Webapi/<tabulas nosaukums>/lauki | Definē ar komatiem atdalītu atribūtu sarakstu, ko var modificēt, izmantojot tīmekļa API. Iespējamās vērtības: - Visi atribūti: * - Specifiski atribūti: attr1,attr2,attr3 Piezīmes: Vērtībai jābūt vai nu zvaigznītei (*), vai ar komatu atdalītam lauku nosaukumu sarakstam. Svarīgi: šis iestatījums ir obligāts vietnes iestatījums. Ja trūkst šī iestatījuma, tiek parādīta kļūda "Šai entītijai nav definētu lauku". |
| Webapi/error/innererror | Iespējo vai atspējo InnerError. Noklusējuma: False Derīgas vērtības: TrueFalse |
| Webapi/<tabulas nosaukums>/disableodatafilter | Iespējo vai atspējo OData filtru. Noklusējuma: False Derīgas vērtības:,Lai iegūtu papildinformāciju, TrueFalse skatiet zināmās problēmas . Vietnes iestatījums ir pieejams portāla versijā 9.4.10.74 vai jaunākā versijā. |
Piezīmes
Lai izmaiņas stātos spēkā, vietas iestatījumiem ir jābūt iestatītiem uz Aktīvs.
Piemēram, lai parādītu tīmekļa API pieteikumu tabulai, kurā autentificētiem lietotājiem ir atļauts veikt šīs entītijas izveides, atjaunināšanas un dzēšanas operācijas, vietnes iestatījumi tiek rādīti nākamajā tabulā.
| Vietnes iestatījuma nosaukums | Vietnes iestatījuma vērtība |
|---|---|
| Webapi/incidents/iespējots | true |
| Webapi/incidents/lauki | attr1, attr2, attr3 |
Drošība, izmantojot portālu tīmekļa API
Ierakstu drošību var konfigurēt atsevišķiem ierakstiem portālos, izmantojot tabulu atļaujas. Portālu Web API piekļūst tabulu (entītiju) ierakstiem un ievēro tabulas atļaujas, kas lietotājiem tiek dotas, izmantojot saistīto tīmekļa lomu.
Varat konfigurēt kolonnu atļaujas, lai, izmantojot portālu tīmekļa API, turpmāk definētu atļaujas atsevišķām tabulas kolonnām.
Tīmekļa API portālu pieprasījumu autentificēšana
Autentifikācijas kods nav jāiekļauj, jo lietojumprogrammas sesija pārvalda autentifikāciju un autorizāciju. Visos tīmekļa API izsaukumos ir jābūt iekļautam Vairākvietu pieprasījuma viltošanas (CSRF) marķierim.
Izmantojiet EntitySetName
Atsaucoties uz Dataverse tabulām, kodā izmantojot portālus Web API, jāizmanto EntitySetName, piemēram, lai piekļūtu konta tabulai, koda sintakse izmanto kontu EntitySetName; /_api/accounts().
Piezīmes
Izmantojiet tabulas loģisko nosaukumu vietnes iestatījumiem (piemēram, uzņēmums).
Noteiktu tabulu EntitySetName var noteikt, veicot šādas darbības:
Dodieties uz https://make.powerapps.com
Sānu panelī atlasiet Dataverse cilni un atlasiet tabulu.
Atlasiet ... (komandu opcija), pēc tam izvēlieties Papildu, Rīki un Kopēt kopas nosaukumu, lai kopētu tabulas EntitySetName starpliktuvē.
Konfidencialitātes tiesību akti un prasības
Visas pieprasījuma galvenes izmanto auditēšanas nolūkos nodotu kontaktpersonas ID. Anonīmam lietotājam šī vērtība tiek nodota kā null.
Ja ir iespējota audita reģistrēšana, lietotājs var skatīt visus audita notikumus Office 365 audita žurnālā.
Papildu informācija:
Darbību reģistrēšanas iespējošana un izmantošana
Audita žurnālierakstu eksportēšana, konfigurēšana un skatīšana
Neatbalstītās konfigurācijas tabulas
Portālu tīmekļa API nevar izmantot tālāk sniegtajām konfigurācijas tabulām:
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
Zināmās problēmas
Lietotāji saņem CDS kļūdu, ja viņi izsauc GET Web API pieprasījumu tabulām, kurām ir vairāki līmeņi no 1 līdz daudziem vai no daudziem līdz daudziemtabulu atļaujām , kad vecāku, ** kontaktpersonu vai kontu tvērumi vaicājumam pievieno papildu nosacījumus.
Lai novērstu šo problēmu, ieteicamais risinājums ir izmantot FetchXML OData vaicājumā.
Vai arī vietnes iestatījumam Webapi/<tabulas nosaukums>/disableodatafilter norādiet vērtību True.
Svarīgi
Mainot vietnes iestatījumu Webapi/<tabulas nosaukums>/disableodatafilter , var True būt lēnāka Web API GET zvanu veiktspēja.
Vietnes iestatījums ir pieejams portāla versijā 9.4.10.74 vai jaunākā versijā.
Nākamā darbība
Datu vaicājums, izmantojot portālu tīmekļa API