Portālu tīmekļa API pārskats
Piezīme
No 2022. gada 12. oktobra, Power Apps portāli ir Power Pages. Papildinformācija. Pakalpojums Microsoft Power Pages tagad ir vispārēji pieejams (emuārs)
Drīzumā Power Apps portālu dokumentācija tiks migrēta un sapludināta ar Power Pages dokumentāciju.
Portāli tīmekļa API ļauj veidot bagātāku lietotāja pieredzi, atrodoties Power Apps portālu lapās. Varat izmantot tīmekļa API, lai visās Microsoft Dataverse tabulās savā portāla lapā veiktu izveides, atjaunināšanas un dzēšanas darbības. Piemēram, varat izveidot jaunu uzņēmumu, atjaunināt kontaktpersonu vai mainīt tabulas atļaujas produktam, izmantojot portālu Tīmekļa API, nevis programmu Portal Management.
Piezīme
Varat izmantot Power Pages tīmekļa API portālus. Papildu informācija: Kas ir Power Pages
Svarīgi
- Jūsu portāla versijai jābūt 9.3.3.x vai jaunākai, lai šis līdzeklis darbotos.
- 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ētos citās Power Apps portālu vietnēs, 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 visu sarakstu, vēlāk šajā tēmā atveriet neatbalstītās konfigurācijas tabulas.
- 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. Ņemiet vērā, ka portāla servera puses kešatmiņas dzēšana izraisa īslaicīgu veiktspējas pasliktināšanos.
- Portālu tīmekļa API operācijām ir nepieciešama Power Apps portālu licence. Piemēram, anonīmu lietotāju veiktie Web API izsaukumi tiek ieskaitīti lapas skata noslodzē. Web API izsaukumi, ko veikuši autentificēti lietotāji (iekšējie vai ārējie), netiek ieskaitīti lapu skatos, bet tiem ir nepieciešamas attiecīgas licences. Papildinformācija: Power Apps bieži uzdotie jautājumi par portālu licencēšanu
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 esam saglabājuši pēc iespējas līdzīgāku API formātu, lai samazinātu mācīšanās līkni.
Piezīme
Tīmekļa API operācijas ir reģistrjutīgas.
Portālos pieejamās tīmekļa API darbības
- Ierakstu lasīšana no tabulas
- Izveidot tabulas ierakstu
- Ierakstu atjaunināšana un dzēšana tabulā
- Tabulu saistīšana un atsaiste
Piezīme
Darbību iespējošana un funkcijas, 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īme
Izmantojiet tabulas loģisko nosaukumu šiem iestatījumiem (piemēram, uzņēmums).
| Vietnes iestatījuma nosaukums | Apraksts |
|---|---|
| Webapi/<table name>/iespējots | Iespējo vai atspējo tīmekļa API pakalpojumam <table name>. Noklusējums: False Derīgās vērtības: True, False |
| Webapi/<table name>/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: * - Noteikti atribūti: attr1,attr2,attr3 Piezīme. Šai vērtībai ir jābūt vai nu zvaigznītei (*), vai ar komatu atdalītam lauku nosaukumu sarakstam. Svarīgi! Šis ir obligāts vietnes iestatījums. Ja šis iestatījums nav redzams, tiek parādīta kļūda "šai entītijai netiek definēti lauki". |
| Webapi/kļūda/innererror | Iespējo vai atspējo InnerError. Noklusējums: False Derīgās vērtības: True, False |
| Webapi/<table name>/disableodatafilter | Iespējo vai atspējo OData filtru. Noklusējums: False Apstiprinātas vērtības: True, False Skatīt zniāmās problēmas, lai gūtu papildu informāciju. Vietnes iestatījums ir pieejams portāla versijā 9.4.10.74 vai jaunākā versijā. |
Piezīme
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/atgadījums/iespējots | true |
| Webapi/atgadījums/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
Nav nepieciešams iekļaut autentifikācijas kodu, jo autentifikācija un autorizācija tiek pārvaldīta lietojumprogrammas sesijā. 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, kas izmanto portālu Web API jūsu kodā, ir jāizmanto EntitySetName, piemēram, lai piekļūtu uzņēmuma tabulai, koda sintakse izmantos uzņēmumu; /_api/accounts() EntitySetName.
Piezīme
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ē.
Vispārīgā datu aizsardzības regula (VDAR)
Visu pieprasījumu galvenēm tiks nodots kontaktpersonas ID, kas paredzēts auditēšanas nolūkiem. Par anonīmu lietotāju tas tiks nodots 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 lietošana
Eksportēt, konfigurēt un skatīt audita žurnāla ierakstus
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ņems CDS kļūdu, ja tie izsauc GET tīmekļa API pieprasījumu tabulām, kuru daudzi vai vairāki līmeņi ir 1 pret daudziem vai daudzi pret daudziem tabulu atļaujas ar definētu primāro tvērumu.
Lai atrisinātu šo problēmu, ieteicamais risinājums ir FetchXML izmantošana OData vaicājumā.
Vai arī iestatiet vietnes iestatījumu Webapi//<table name>/disableodatafilter kā True.
Svarīgi
Vietnes iestatījuma Webapi//<table name>/disableodatafilter mainīšana uz True var palēnināt tīmekļa API GET izsaukumu veiktspēju.
Vietnes iestatījums ir pieejams portāla versijā 9.4.10.74 vai jaunākā versijā.
Nākamā darbība
Vaicājumu dati, izmantojot portālu tīmekļa API
Skatiet arī:
HTTP pieprasījumu veidošana un darbs ar kļūdām
Portālu rakstīšanas, atjaunināšanas un dzēšanas darbības, izmantojot Tīmekļa API
Apmācība: portāla tīmekļa API lietošana
Piezīme
Kādas ir jūsu dokumentācijas valodas preferences? Aizpildiet īsu aptauju. (ņemiet vērā, ka aptauja ir angļu valodā)
Aptaujai būs nepieciešamas aptuveni septiņas minūtes. Nekādi personas dati netiks vākti (paziņojums par konfidencialitāti).
Atsauksmes
Drīzumā: 2024. gada laikā mēs pakāpeniski pārtrauksim izmantot “GitHub problēmas” kā atsauksmju par saturu mehānismu un aizstāsim to ar jaunu atsauksmju sistēmu. Papildinformāciju skatiet: https://aka.ms/ContentUserFeedback.
Iesniegt un skatīt atsauksmes par