Portalų žiniatinklio API apžvalga
Portalų žiniatinklio API įgalina platesnę vartotojo patirtį „Power Pages“ svetainėse. Naudodami žiniatinklio API galite atlikti kūrimo, skaitymo, naujinimo ir naikinimo operacijas visose „Microsoft Dataverse” lentelėse iš savo tinklalapių. Pavyzdžiui, galite sukurti naują abonementą, atnaujinti kontaktą, nesinaudodami forma ar kelių objektų formos naudodami žiniatinklio API portalą.
Svarbu
- Kad Power Pages ši funkcija veiktų, jūsų svetainės versija turi būti 9.3.3.x arba naujesnė.
- Portalų žiniatinklio API yra sukurtas platesnės vartotojo patirties kūrimui portalo puslapiuose. Jis nėra optimizuotas trečiųjų šalių paslaugoms ar programos integravimui. Portalų žiniatinklio API naudojimas integruoti su kitomis svetainėmis Power Pages taip pat nepalaikomas.
- Portalų Žiniatinklio API operacijos atliekamos tik lentelėse, susijusiose su duomenimis - pavyzdžiui, paskyromis, kontaktais ar jūsų pasirinktinėmis lentelėmis. Konfigūracijos lentelės metaduomenys ar portalo konfigūracijos lentelės duomenys - pavyzdžiui, portalų lentelių, tokių kaip „adx_contentsnippet”, „adx_entityform”, arba „adx_entitylist - konfigūravimas, nėra palaikomi su portalų Žiniatinklio API. Norėdami gauti visą sąrašą, eikite į nepalaikomas konfigūracijos lenteles toliau šiame straipsnyje.
- Portalų žiniatinklio API gauna naudos išserverio talpyklos, todėl vėlesnės žiniatinklio API iškvietos yra greitesnės nei pradinės. Išvalius portalo serverio talpyklą, laikinai pablogėja našumas.
- Portalų žiniatinklio API operacijoms atlikti reikia „Power Pages“ licencijos. Pavyzdžiui, anoniminių vartotojų atlikti žiniatinklio API skambučiai skaičiuojami anonimimo vartotojo pajėgumą. Autentifikuotų vartotojų (vidiniai arba išoriniai) žiniatinklio API skambučiai neįskaičiuojami į puslapio peržiūras, tačiau jiems reikalingos taikomos autentifikuotos vartotojo pajėgumo licencijos. Daugiau informacijos: Power Pages“ leidimų DUK.
Žiniatinklio API operacijos
Portalų žiniatinklio API teikia papildomą galimybių rinkinį „Dataverse“ veiksmams, kuriuos galite atlikti naudodami „Dataverse“ API. Mes išlaikėme API formatą kuo panašesnį, kad sumažintume mokymosi kreivę.
Pastaba.
Žiniatinklio API operacijose skiriamos mažosios ir didžiosios raidės.
Žiniatinklio API operacijos, pasiekiamos Power Pages
- Įrašų skaitymas iš lentelės
- Įrašo kūrimas lentelėje
- Lentelės įrašų naujinimas ir naikinimas
- Lentelių susiejimas ir atsiejimas
Svetainės nustatymai žiniatinklio API
Turite įjungti svetainės nustatymus tam, kad įjungtumėte portalų žiniatinklio API savo portalui. Taip pat galite sukonfigūruoti lauko lygio žiniatinklio API, nulemiančią, ar lentelės laukai gali būti modifikuojami naudojant portalų žiniatinklio API, ar negali.
Pastaba.
Naudokite lentelę loginis pavadinimas šiems parametrams (pavyzdžiui, paskyra).
| Svetainės pavadinimo nustatymas | Aprašą |
|---|---|
| Webapi/<lentelės pavadinimas>/įgalinta | Įjungia ar išjungia žiniatinklio API <lentelės pavadinimą>. Numatytasis: False Galiojančios vertės: True, False |
| Webapi/<lentelės pavadinimas>/laukai | Nustato kableliu atskirtų savybių sąrašą, kuris gali būti keičiamas su žiniatinklio API. Galimos vertės: - Visi atributai: * - Specifiniai požymiai: attr1,attr2,attr3 pastabos: Reikšmė turi būti žvaigždutė (*) arba kableliais atskirtas laukų pavadinimų sąrašas. Svarbu: šis nustatymas yra privalomas svetainės parametras. Kai šio parametro nėra, rodoma klaida "Nėra šiam objektui apibrėžtų laukų". |
| Webapi/error/innererror | Įjungia ar išjungia vidinę klaidą. Numatytasis: False Galiojančios vertės: True, False |
| Webapi/<lentelės pavadinimas>/disableodatafilter | Įjungia arba išjungia „OData“ filtrą. Numatytasis: False Leistinos reikšmės:,Norėdami True gauti daugiau informacijos, False žiūrėkite žinomas problemas . Svetainės parametras pasiekiamas portalo versijoje 9.4.10.74 arba naujesnėje. |
Pastaba.
Svetainės parametrai turi būti nustatyti kaip Aktyvūs, norint, kad jie įsigaliotų.
Pavyzdžiui, kad būtų rodoma atvejo lentelės žiniatinklio API, kurioje autentifikuotiems vartotojams leidžiama atlikti šio objekto kūrimo, naujinimo ir naikinimo operacijas, svetainės parametrai parodyti toliau pateiktoje lentelėje.
| Svetainės pavadinimo nustatymas | Svetainės nustatymo vertė |
|---|---|
| Webapi/incident/enabled | teisinga |
| Webapi/incidentas/laukai | attr1, attr2, attr3 |
Saugumas su portalų žiniatinklio API
Galite konfigūruoti įrašais pagrįstą saugą atskiriems portalų įrašams naudodami lentelių teises. Portalų žiniatinklio API pasiekia lentelės (objektas) įrašus ir vadovaujasi lentelės teisėmis, suteiktomis vartotojams per susietą žiniatinklio vaidmenį.
Galite sukonfigūruoti stulpelių teises norėdami toliau apibrėžti atskirų lentelės stulpelių teises naudodami portalų žiniatinklio API.
Portalų žiniatinklio API užklausų autentifikavimas
Jums nereikia įtraukti autentifikavimo kodo, nes programos seansas valdo autentifikavimą ir autorizavimą. Visi žiniatinklio API skambučiai turi apimti kryžminės svetainės užklausos klastojimo (CSRF) žymą.
EntitySetName naudojimas
Kai nurodote Dataverse lenteles, kurių kode naudojama portalų žiniatinklio API, turite naudoti EntitySetName, pavyzdžiui, norėdami pasiekti sąskaitos lentelę, kodo sintaksė naudoja sąskaitų EntitySetName; /_api/accounts().
Pastaba.
Naudokite lentelės loginį pavadinimą svetainės parametrams (pavyzdžiui, paskyra).
Galite nustatyti konkrečių lentelių EntitySetName atlikdami šiuos veiksmus:
Eikite į „https://make.powerapps.com“
Pasirinkite skirtuką Dataverse iš šoninio skydo ir pasirinkite lentelę.
Pasirinkite ... (Komandų parinktis) ir Išplėstinis, Įrankiai, Kopijuoti rinkinio pavadinimą norėdami nukopijuoti lentelės EntitySetName į savo mainų sritį.
Privatumo įstatymai ir taisyklės
Visose užklausų antraštėse audito tikslais naudojamas perduotas kontakto ID. Anoniminiam vartotojui ši reikšmė perduodama kaip null.
Jei auditavimo prisijungimas yra įjungtas, vartotojas gali matyti visus audito įvykius „Office 365“ audito žurnale.
Daugiau informacijos:
Veiklos registravimo įgalinimas ir naudojimas
Audito žurnalo įrašų eksportavimas, konfigūravimas ir peržiūra
Nepalaikomos konfigūracijos lentelės
Portalų žiniatinklio API negalima naudoti šiose konfigūracijos lentelėse:
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
Žinomos problemos
Vartotojai gauna CDS klaidą, jei iškviečia GET žiniatinklio API užklausą lentelėms, turinčioms kelis lygius nuo 1 iki daugelio arba nuo daugelio iki daugeliolentelių teisių , kai pirminės, ** kontaktinės arba paskyros aprėptis į užklausą įtraukia daugiau sąlygų.
Norėdami išspręsti šią problemą, rekomenduojamas sprendimas yra naudoti FetchXML "OData" užklausoje.
Arba nustatykite svetainės parametro Webapi/ lentelės< pavadinimas> / disableodatafilter reikšmę True.
Svarbu
Pakeitus svetainės parametrą Webapi/<table name>/disableodatafilter, gali True sulėtėti žiniatinklio API GET skambučių veikimas.
Svetainės parametras pasiekiamas portalo versijoje 9.4.10.74 arba naujesnėje.
Tolesnis veiksmas
Užklausų duomenys naudojant portalų žiniatinklio API