Pregled spletnega API-ja za portale
Spletni API za portale omogoča bogatejšo uporabniško izkušnjo na spletnih mestih Power Pages. Spletni API lahko uporabite za izvajanje postopkov ustvarjanja, branja, posodabljanja in brisanja v vseh tabelah storitve Microsoft Dataverse na svojih spletnih straneh. S spletnim API-jem za portale lahko na primer ustvarite nov račun in posodobite stik, ne da bi uporabili obrazec ali obrazec z več koraki.
Pomembno
- Za delovanje te funkcije morate uporabljati različico spletnega mesta Power Pages 9.3.3.x ali novejšo.
- Spletni API portalov je bil ustvarjen za grajenje bogate uporabniške izkušnje znotraj strani portalov. Ni optimiziran za storitve tretjih ponudnikov ali integracijo aplikacij. Uporaba spletnega API-ja za portale za integracijo z drugimi spletnimi mesti Power Pages prav tako ni podprta.
- Postopki spletnih API-jev za portale so omejeni na tabele, povezane s podatki – na primer kupce, stike ali tabele po meri. Konfiguriranje metapodatkov tabele ali podatkov konfiguracijske tabele portala – na primer konfiguriranje tabel portalov, kot so adx_contentsnippet, adx_entityform ali adx_entitylist – ni podprto s spletnim API-jem za portale. Za celoten seznam pojdite na nepodprte konfiguracijske tabele v nadaljevanju v tej temi.
- Prednosti spletnega API-ja portalov so predpomnjenje na strežniški strani, zaradi česar so klici spletnega API-ja hitrejši od prvotnih klicev. Upoštevajte, da brisanje strežniškega predpomnilnika povzroči začasno slabše delovanje.
- Za postopke spletnega API-ja za portale potrebujete licenco za Power Pages. Klici spletnega API-ja, ki jih opravijo anonimni uporabniki, se na primer štejejo v zmogljivost anonimnega uporabnika. Klici spletnega API-ja, ki jih opravijo uporabniki s preverjeno pristnostjo (notranji ali zunanji), se ne štejejo med oglede strani, vendar zahtevajo ustrezne licence za zmogljivost uporabnikov s preverjeno pristnostjo. Več informacij: Pogosta vprašanja o licenciranju za Power Pages
Postopki spletnih API-jev
Spletni API portala ponuja podmnožico zmogljivosti za operacije Dataverse, ki jih lahko izvedete z uporabo API-ja Dataverse. Obliko API-ja smo ohranili čim bolj podobno, da bi skrajšali krivuljo učenja.
opomba,
Postopki spletnega API-ja razlikujejo med velikimi in malimi črkami.
Postopki spletnih API-jev, ki so na voljo v storitvi Power Pages
- Branje zapisov iz tabele
- Ustvarjanje zapisa v tabeli
- Posodabljanje in brisanje zapisov v tabeli
- Povezovanje in ločevanje tabel
Nastavitve spletnega mesta za spletni API
Če želite za svoj portal omogočiti spletni API portalov, morate omogočiti nastavitev spletnega mesta. Poleg tega lahko konfigurirate spletni API na ravni polja, ki določa polja tabel, ki jih je mogoče spremeniti s spletnim API-jem portalov ali pa ne.
opomba,
Uporabite tabelo logično ime za te nastavitve (npr. račun).
| Ime nastavitve mesta | Opis |
|---|---|
| Webapi/<table name>/enabled | Omogoči ali onemogoči spletni API za <ime tabele>. Privzeto: False Veljavne vrednosti: True, False |
| Webapi/<table name>/fields | Določa seznam atributov, ločenih z vejicami, ki jih je mogoče spremeniti s spletnim API-jem. Možne vrednosti: - Vsi atributi: * - Določeni atributi: attr1,attr2,attr3 Opomba: Vrednost mora biti zvezdica (*) ali seznam z imeni polj, ločenih z vejico. Pomembno: To je obvezna nastavitev spletnega mesta. Če ta nastavitev manjka, se vam bo prikazala napaka »Za to entiteto ni določeno nobeno polje«. |
| Webapi/error/innererror | Omogoči ali onemogoči InnerError. Privzeto: False Veljavne vrednosti: True, False |
| Webapi/<table name>/disableodatafilter | Omogoči ali onemogoči filter OData. Privzeto: False Veljavne vrednosti: True, False Za več informacij glejte znane težave. Nastavitev mesta je na voljo v različici portala 9.4.10.74 ali novejši. |
opomba,
Nastavitve mesta morajo biti nastavljene na Aktivno, da spremembe začnejo veljati.
Če želite na primer izpostaviti spletni API za tabelo primerov, kjer lahko uporabniki s preverjeno pristnostjo izvajajo postopke ustvarjanja, posodabljanja in brisanja te entitete, so nastavitve spletnega mesta prikazane v naslednji tabeli.
| Ime nastavitve mesta | Vrednost nastavitve mesta |
|---|---|
| Webapi/incident/enabled | true |
| Webapi/incident/fields | attr1, attr2, attr3 |
Varnost s spletnim API-jem portalov
Varnost na podlagi zapisov lahko za posamezne zapise na portalih konfigurirate z dovoljenji za tabele. Spletni API portalov dostopa do zapisov tabele (entitete) in sledi dovoljenjem za tabele, ki so uporabnikom dodeljene prek povezane spletne vloge.
Konfigurirate lahko dovoljenja za stolpce za nadaljnjo določitev pravic za posamezne stolpce v tabeli med uporabo spletnega API-ja portalov.
Preverjanje pristnosti zahtevkov spletnih API-jev za portale
Kode za preverjanje pristnosti vam ni treba vključiti, ker preverjanje pristnosti in pooblastitev upravlja seja aplikacije. Vsi klici spletnega API-ja morajo vsebovati žeton za ponarejanje zahteve prek spletnih mest (CSRF).
Uporaba EntitySetName
Pri sklicevanju na tabele Dataverse, ki v vaši kodi uporabljajo spletni API portalov, morate uporabiti EntitySetName, na primer za dostop do tabele računa bo sintaksa kode uporabljala ime EntitySetName računov; /_api/accounts().
opomba,
Uporabite logično ime tabele za nastavitve mesta (npr. račun).
Določite lahko ime EntitySetName določenih tabel, če upoštevate naslednje korake:
Odprite https://make.powerapps.com
Izberite zavihek Dataverse na stranski plošči in izberite tabelo.
Izberite ... (možnost Ukazi) in nato izberite Napredno, Orodja in Kopiraj nastavljeno ime, da kopirate ime EntitySetName tabele v odložišče.
Zakoni in predpisi glede zasebnosti
Vse glave zahtev bodo imele ID stika, ki je posredovan za namene nadzora. Za anonimnega uporabnika bo posredovan kot null.
Če je vodenje dnevnika nadzora omogočeno, lahko uporabnik vidi vse dogodke nadzora v dnevniku nadzora za Office 365.
Več informacij:
Omogočanje in uporaba beleženja dejavnosti
Izvoz, konfiguracija in ogled zapisov v dnevniku nadzora
Nepodprte konfiguracijske tabele
Spletnega API-ja portalov ne morete uporabiti za naslednje konfiguracijske tabele:
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
Znane težave
Uporabniki bodo prejeli napako CDS, če pokličejo GET zahtevo spletnega API-ja za tabele, ki imajo več ravni od 1 do več ali veliko proti mnogodovoljenja tabele ko Starševsko, Stik ali Račun obseg dodaja poizvedbi dodatne pogoje.
Če želite odpraviti to težavo, uporabite priporočeno rešitev FetchXML v poizvedbi OData.
Nastavitev Webapi/<table name>/disableodatafilter za spletno mesto lahko nastavite tudi na True.
Pomembno
Če spremenite nastavitev mesta Webapi/<table name>/disableodatafilter na True, lahko klici spletnega API-ja GET delujejo počasneje.
Nastavitev mesta je na voljo v različici portala 9.4.10.74 ali novejši.
Naslednji korak
Poizvedba podatkov s spletnim API-jem za portale