Zdieľať cez


Prehľad webového rozhrania API portálov

Webové rozhranie API portálov umožňuje vytvoriť bohatšie používateľské prostredie vnútri lokalít Power Pages. Webové rozhrania API môžete použiť na vykonávanie operácií vytvárania, čítania, aktualizácie a odstraňovania vo všetkých tabuľkách Microsoft Dataverse z vašich webových stránok. Môžete si napríklad vytvoriť nový účet, aktualizovať kontakt bez použitia formulára alebo viackrokového formulára pomocou pomocou webového rozhrania API portálu.

Dôležité

  • Verzia vašej Power Pages stránky musí byť 9.3.3.x alebo novšia, aby táto funkcia fungovala.
  • Web API portálov je vyrobené na vytváranie bohatej používateľskej skúsenosti na stránkach portálu. Nie je optimalizovaný pre služby tretích strán alebo integráciu aplikácií. Používanie webového rozhrania API portálu na integráciu s inými lokalitami Power Pages tiež nie je podporované.
  • Operácie webového rozhrania API portálov sú obmedzené na tabuľky súvisiace s údajmi—napríklad obchodnými vzťahmi, kontaktmi alebo vlastnými tabuľkami. Konfigurácia metaúdajov tabuľky alebo údajov tabuľky konfigurácie portálu—napríklad konfigurácia portálových tabuliek ako adx_contentsnippet, adx_entityform alebo adx_entitylist—nie je podporovaná webovým rozhraním API portálov. Úplný zoznam nájdete v časti nepodporované konfiguračné tabuľky ďalej v tomto článku.
  • Webové rozhranie API portálov ťaží z ukladania do vyrovnávacej pamäte na strane servera, takže následné volania webového rozhrania API sú rýchlejšie ako počiatočné volania. Vymazanie vyrovnávacej pamäte na strane servera portálu spôsobí dočasné zníženie výkonu.
  • Prevádzka webového rozhrania API portálov vyžaduje licenciu Power Pages. Napríklad volania webového rozhrania API uskutočnené anonymným používateľom sa počítajú do kapacity zobrazenia stránky. Volania webového rozhrania API uskutočnené overenými používateľmi (internými alebo externými) sa nezapočítavajú do zobrazení stránky, ale vyžadujú si príslušné licencie na kapacitu overeného používateľa. Ďalšie informácie: Najčastejšie otázky o licencovaní Power Pages.

Operácie webových rozhraní aplikácie

Portály Web API ponúka podmnožinu funkcií pre operácie Dataverse, ktoré môžete vykonať pomocou Dataverse API. Formát API sme ponechali čo najpodobnejší, aby sme skrátili krivku učenia.

Poznámka

Operácie webového rozhrania API rozlišujú veľké a malé písmená.

Operácie webového rozhrania API dostupné na Power Pages

Poznámka

Volanie akcií a funkcií pomocou webového rozhrania API portálu nie je podporované.

Nastavenia lokality pre Web API

Musíte povoliť nastavenie lokality, aby ste povolili portály Web API pre váš portál. Môžete tiež nakonfigurovať webové rozhranie API na úrovni poľa, ktoré určuje polia tabuľky, ktoré je alebo nie je možné upravovať pomocou webového rozhrania API portálov.

Poznámka

Použite logický názov tabuľky pre tieto nastavenia (napr. obchodný vzťah).

Názov nastavenia lokality Popis
Webapi/<názov tabuľky>/povolené Povolí alebo zakáže webové rozhranie API pre <názov tabuľky>.
Predvolená hodnota:False
Platné hodnoty:True, False
Webapi/<názov tabuľky>/polia Definuje zoznam atribútov oddelených čiarkami, ktoré je možné upraviť pomocou webového rozhrania API.
Možné hodnoty:
- Všetky atribúty:*
- Špecifické atribúty:attr1,attr2,attr3
Poznámka: Hodnota musí byť buď hviezdička (*) alebo zoznam názvov polí oddelených čiarkami.
Dôležité: Toto nastavenie je povinné nastavenie lokality. Ak toto nastavenie chýba, zobrazí sa chyba „Pre túto entitu nie sú definované žiadne polia“.
Webapi/chyba/vnútorná chyba Povolí alebo zakáže InnerError.
Predvolená hodnota:False
Platné hodnoty:True, False
Webapi/<názov tabuľky>/disableodatafilter Povolí alebo zakáže filter OData.
Predvolená hodnota:False
Platné hodnoty:True, False Viac informácií nájdete v časti známe problémy . Nastavenie lokality je dostupné vo verzii portálu 9.4.10.74 alebo neskôr.

Poznámka

Nastavenia stránok musia byť nastavené na Aktívne, aby sa zmeny prejavili.

Napríklad na vystavenie webového rozhrania API pre tabuľku prípadov, kde môžu overení používatelia vykonávať operácie vytvárania, aktualizovania a mazania na tejto entite, sú nastavenia lokality zobrazené v nasledujúcej tabuľke.

Názov nastavenia lokality Hodnota nastavenia lokality
Webapi/incident/povolené true
Webapi/incident/fields attr1, attr2, attr3

Zabezpečenie pomocou webového rozhrania API portálov

Zabezpečenie založené na záznamoch môžete nakonfigurovať na jednotlivé záznamy na portáloch pomocou povolení tabuliek. Webové rozhranie API portálov pristupuje k záznamom tabuľky (entity) a riadi sa povoleniami tabuľky, ktoré dostali užívatelia prostredníctvom pridruženej webovej roly.

Môžete konfigurovať povolenia stĺpcov na ďalšie definovanie privilégií pre jednotlivé stĺpce v tabuľke pri používaní webového rozhrania API portálu.

Overovanie požiadaviek portálov Web API

Nemusíte zadávať autentifikačný kód, pretože autentifikáciu a autorizáciu riadi relácia aplikácie. Všetky volania webového API musia obsahovať token CSRF (Cross-Site Request Forgery).

Pomocou EntitySetName

Keď vo svojom kóde odkazujete na tabuľky Dataverse pomocou webového rozhrania API portálu, musíte použiť EntitySetName, napríklad na prístup k account tabuľka, syntax kódu používa EntitySetName z účtov; /_api/accounts().

Poznámka

Použite logický názov tabuľky nastavenia lokality (napr. obchodný vzťah).

Môžete určiť EntitySetName konkrétnych tabuliek podľa týchto krokov:

  1. Prejsť do systému https://make.powerapps.com

  2. Vyberte tabuľku Dataverse z bočného panela a vyberte tabuľku.

  3. Vyberte ... (možnosť Príkazy) a potom vyberte Pokročilé, Nástroje a Kopírovať názov množiny na skopírovanie EntitySetName tabuľky do schránky.

    Ako nájsť EntitySetName tabuľky Dataverse.

Zákony a nariadenia o ochrane súkromia

Všetky hlavičky žiadostí používajú ID kontaktu odovzdané na účely auditu. Pre anonymného používateľa sa táto hodnota odovzdá ako null.

Ak je povolené protokolovanie auditu, používateľ môže vidieť všetky udalosti auditu v denníku auditu Office 365.

Snímka obrazovky  Office 365 revízneho denníka.

Ďalšie informácie:
Povoliť a používať protokolovanie aktivít
Exportujte, konfigurujte a zobrazujte záznamy denníka auditu

Nepodporované konfiguračné tabuľky

Webové rozhranie API portálov nemožno použiť pre nasledujúce konfiguračné tabuľky:

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

Známe problémy

Používatelia dostanú chybu CDS, ak vyvolajú požiadavku GET Web API pre tabuľky, ktoré majú viacero úrovní 1 až veľa alebo veľa k mnohýmpovoleniam tabuľky keď Rodičovský, **Kontakt, alebo Účet rozsahy pridávajú do dopytu ďalšie podmienky.

Ak chcete vyriešiť tento problém, odporúčaným riešením je použiť FetchXML v dotaze OData.

Prípadne nastavte nastavenie webu Webapi/<názov tabuľky>/disableodatafilter na True.

Dôležité

Zmena nastavenia webu Webapi/<názov tabuľky>/disableodatafilter na True môže spôsobiť spomalenie výkon pre volania Web API GET .

Nastavenie lokality je dostupné vo verzii portálu 9.4.10.74 alebo neskôr.

Ďalší krok

Dopytujte údaje pomocou webového rozhrania API portálu