Portaalide veebi API ülevaade
Portaalide veebi-API võimaldab luua rikkamat kasutajakogemust teenuse Power Pages saitidel. Veebi-API abil saate luua, lugeda, värskendada ja kustutada oma veebilehtedelt kõiki rakenduse Microsoft Dataverse tabeleid. Näiteks saate portaalide veebi API abil luua uue konto, uuendada kontakti ilma vormi või mitmeetapilise vormita veebi API portaaalide abil.
Oluline
- Teie teenuse Power Pages saidiversioon peab olema 9.3.3.x või uuem, et see funktsioon töötaks.
- Portaalide veebi-API on ehitatud rikkama kasutajakogemuse loomiseks portaalide lehtedel. See pole optimeeritud kolmanda osapoole teenuste ega rakenduste integreerimise jaoks. Samuti ei toetata portaalide veebi API kasutamist teiste teenuse Power Pages saitidega integreerimiseks.
- Portaalide API toimingud on piiratud tabelitega, mis on seotud andmetega nt kontode, kontaktide või teie kohandatud tabelitega. Tabelite metaandmete või portaali seadistus-tabeli andmete konfigureerimine, nt portaalide tabelite konfigureerimine, näiteks adx_contentsnippet, adx_entityform või adx_entitylistpole portaalide API-ga toetatud. Täieliku loendi saamiseks vaadake toetamata konfiguratsioonitabeleid (toodud hiljem käesolevas jaotises).
- Portaalid saavad veebi-API serveripoolse vahemälust kasu, seega ka järgnevad kutsed veebi-API-le on kiiremad, kui algsed. Pidage meeles, et portaali serveripoolse vahemälu tühjendamise järel halveneb jõudlus ajutiselt.
- Portaalide veebi-API toimingud nõuavad teenuse Power Pages litsentsi. Näiteks anonüümsete kasutajate poolt tehtud Veebi API kõned loendatakse anonüümse kasutaja võimsuseks. Veebi API kõned, mis on tehtud autentitud kasutajate poolt (sise või välis) eiole arvestatud lehevaate poole, vaid nõuavad kohalduvaid autenditud kasutaja võimsuse litsentse. Lisateave: Power Pages llitsentsimise KKK
Veebi-API toimingud
Portaalide veebi-API pakub võimalusi Dataverse allüksuste toimingute jaoks, mida saate teha Dataverse API abil. Õppimiskõvera vähendamiseks oleme hoidnud API-vormingut nii sarnasena kui võimalik.
Märkus.
Veebi-API toimingud on tõstutundlikud.
Teenuse Power Pages saadaval veebi-API toimingud
- Kirjete lugemine tabelist
- Looge tabelis kirje
- Kirjete uuendamine ja kustutamine tabelist
- Tabelite seostamine ja eraldamine
Märkus.
Portaalide veebi-API-sid kasutades toimingute ja funktsioonide kutsumist ei toetata.
Veebi-API veebisätted
Peate lubama saidi sätted, et lubada portaalide veebi-API oma portaalis. Lisaks saate konfigureerida väljataseme veebi-API, mis määrab tabeliväljad, mida saab või ei saa portaalide veebi-API abil muuta.
Märkus.
Kasutage nende sätete jaoks tabelis loogilist nime (näiteks konto).
| Saidi sätte nimi | Kirjeldus |
|---|---|
| Webapi/<tabelinimi>/lubatud | Lubab või keelab veebi-API <tabelinime> jaoks. Vaikesäte: False Sobivad väärtused: True, False |
| Webapi/<tabelinimi>/väljad | Määratleb komaga eraldatud loendi atribuutidest, mida saab veebi-API abil muuta. Võimalikud väärtused: - Kõik atribuudid: * - Täpsed atribuudid: attr1,attr2,attr3 Märkus: väärtus peab olema kas tärn (*) või väljanimede komaeraldusega loend. Tähtis: see on saidi kohustuslik säte. Kui see säte puudub, kuvatakse tõrketeade "selle olemi jaoks pole väljad määratletud". |
| Webapi/tõrge/innererror | Lubab või keelab sisemised vead. Vaikesäte: False Sobivad väärtused: True, False |
| Webapi/<tabelinimi>/disableodatafilter | Lubab või keelab OData filtri. Vaikesäte: False Sobivad väärtused: True, False Vt lisateavet teadaolevatest probleemidest. Saidi säte on saadaval portaali versioonis 9.4.10.74 või hilisemas. |
Märkus.
Muudatuste jõustumiseks peavad saidisätted olema seatud aktiivseks.
Näiteks selleks, et eksponeerida veebiliidese juhtumitabeli jaoks, kus autentitud kasutajad saavad selle olemiga luua, värskendada ja kustutada, kuvatakse saidi sätted järgmises tabelis.
| Saidi sätte nimi | Saidisätte väärtus |
|---|---|
| Webapi/intsident/lubatud | true |
| Webapi/intsident/väljad | attr1, attr2, attr3 |
Turvalisus portaalide veebi-API abil
Kirjepõhise turvalisuse saate konfigureerida portaalide üksikute kirjete jaoks, kasutades tabeli õigusi. Portaalide veebiliides pääseb juurde tabelikirjetele (olem) ja järgib seostatud veebirolli kaudu kasutajatele antud tabeli lubasid.
Portaalide veebi-API-d kasutades saate veeruõiguseid konfigureerida tabeli üksikute veergude jaoks täiendavate õiguste määratlemiseks.
Portaalide veebi-API päringute autentimine
Te ei pea lisama autentimiskoodi, kuna autentimist ja autoriseerimist haldab rakenduse seanss. Kõik veebi-API kõned peavad sisaldama saidiülese päringu võltsimise (CSRF) luba.
Atribuudi EntitySetName kasutamine
Portaalide veebi-API-t kasutades oma koodis Dataverse’i tabelitele viitamisel peate kasutama väärtust EntitySetName. Näiteks konto tabelile juurdepääsuks kasutab koodisüntaks kontode jaoks väärtust EntitySetName; /_api/accounts().
Märkus.
Kasutage saidi sätete jaoks tabelis loogilist nime (näiteks konto).
Kindlate tabelite atribuudi EntitySetName määramiseks tehke järgmist.
Valige külgpaneelil vahekaart Dataverse ja valige tabel.
Valige suvand ... (Käsud) ja seejärel valige Täpsem, Tööriistad ja Kopeeri kogumi nimi, et kopeerida tabeli atribuut EntitySetName oma lõikelauale.
Privaatsusseadused ja regulatsioonid
Kõigil taotluse päistel on auditeerimise eesmärkidel edastatud kontakti ID. Anonüümsele kasutajale saadetakse see edasi kui null.
Kui auditi logimine on lubatud, saab kasutaja kontrollida kõiki auditeerimise sündmusi Office 365 auditeerimise Logis.
Lisateave:
Tegevuslogi lubamine ja kasutamine
Auditi logide eksportimine, konfigureerimine ja vaatamine
Toetamata konfiguratsioonitabelid
Portaalide veebi-API-d ei saa kasutada järgmiste konfiguratsioonitabelite jaoks.
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
Teadaolevad probleemid
Kasutajad saavad CDS-i tõrke, kui nad käivitavad GET Web API taotluse tabelite kohta, millel on mitu taset 1 kuni palju või palju kuni paljutabeliõigusi , kui vanem-, kontakti - või kontoulatused lisavad päringule täiendavaid tingimusi.
Selle probleemi lahendamiseks on soovitatav kasutada FetchXML OData päringut.
Teise võimalusena määrake saidi sätte Webapi/<tabeli nimi>/disableodatafilter väärtuseks True.
Oluline
Saidi sätte Webapi/tabeli bunu</>disableodatafilter muutmine võib True põhjustada veebi-API GET kõnede jõudlust aeglustada.
Saidi säte on saadaval portaali versioonis 9.4.10.74 või hilisemas.
Järgmine etapp
Portaalide veebi API-ga andmete päring