Pregled spletnega API-ja za portale

Opomba

Od 12. oktobra 2022 najprej je portal Power Apps Power Pages. Več informacij: Microsoft Power Pages je zdaj splošno dostopen (spletni dnevnik)
Dokumentacijo portalov Power Apps bomo kmalu preselili in združili z dokumentacijo za Power Pages.

Spletni API portalov omogoča bogatejšo uporabniško izkušnjo na straneh portalov Power Apps. Spletni API lahko uporabite za izvajanje postopkov ustvarjanja, branja, posodabljanja in brisanja v vseh tabelah Microsoft Dataverse na straneh portalov. S spletnim API-jem portalov lahko namesto z aplikacijo za upravljanje portala za izdelek ustvarite na primer nov račun, posodobite stik ali spremenite dovoljenja za tabele.

Opomba

Spletni API portalov lahko uporabljate tudi v storitvi Power Pages. Več informacij: Kaj je Power Pages

Pomembno

  • Za delovanje te funkcije morate imeti portal različice 9.3.3.x ali novejše.
  • 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 portalov za integracijo z drugimi mesti portalov Power Apps tudi ni podprta.
  • Delovanje spletnih API-jev portalov je omejeno na tabele, povezane s podatki— na primer računi, stiki ali tabelami 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 podprt s spletnim API-jem portalov. 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 portalov potrebujete licenco za portale Power Apps. Na primer, klici spletnega API-ja, ki jih opravijo anonimni uporabniki, se štejejo v zmogljivost ogleda strani. Klici spletnega API-ja, ki jih opravijo overjeni uporabniki (notranji ali zunanji), se ne štejejo med oglede strani, vendar zahtevajo ustrezne licence. Več informacij: Pogosta vprašanja o licenciranju portalov Power Apps

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 na portalih

Opomba

Klicanje dejanj in funkcij z uporabo spletnega API-ja portalov ni podprta.

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 Description
Webapi/<table name>/enabled Omogoči ali onemogoči spletni API za <table name>.
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 bodisi 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.

Varnost spletnega API-ja za portale.

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:

  1. Odprite https://make.powerapps.com

  2. Izberite zavihek Dataverse na stranski plošči in izberite tabelo.

  3. Izberite ... (možnost Ukazi) in nato izberite Napredno, Orodja in Kopiraj nastavljeno ime, da kopirate ime EntitySetName tabele v odložišče.

    Kako poiskati ime EntitySetName tabele Dataverse.

Splošna uredba o varstvu podatkov (GDPR)

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.

Dnevnik spremljanja sprememb v Office 365.

Več informacij:
Omogočanje in uporaba beleženja dejavnosti
Izvozite, konfigurirajte in si oglejte zapise dnevnika 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

Uporabnikom se prikaže napaka CDS, če prikličejo zahtevo spletnega API-ja GET za tabele, ki imajo več ravni 1 proti mnogim ali mnogi proti mnogim dovoljenja za tabele z opredeljenim obsegom nadrejeno.

Če želite odpraviti to težavo, uporabite priporočeno rešitev FetchXML v poizvedbi OData.

Druga možnost je, da nastavitev mesta Webapi/<table name>/disableodatafilter nastavite na True.

Pomembno

Če spremenite nastavitev mesta Webapi/<table name>/disableodatafilter na True, lahko to upočasni delovanje klicev spletnega API-ja GET.

Nastavitev mesta je na voljo v različici portala 9.4.10.74 ali novejši.

Naslednji korak

Poizvedba podatkov s spletnim API-jem portalov

Glejte tudi

Sestavljanje zahtev HTTP in obravnava napak
Postopki pisanja, posodabljanja in brisanja z uporabo spletnih API-jev portalov
Vadnica: uporaba spletnega API-ja portalov

Opomba

Ali nam lahko poveste, kateri je vaš prednostni jezik za dokumentacijo? Izpolnite kratko anketo. (upoštevajte, da je v angleščini)

Z anketo boste porabili približno sedem minut. Ne zbiramo nobenih osebnih podatkov (izjava o zasebnosti).