Prehľad webového rozhrania API portálov

Poznámka

S účinnosťou od 12. októbra 2022 sa portály Power Apps nazývajú Power Pages. Ďalšie informácie: Služba Microsoft Power Pages je teraz všeobecne dostupná (blog)
Čoskoro vykonáme migráciu a zlúčenie dokumentácie k portálom Power Apps s dokumentáciou k službe Power Pages.

Webové rozhranie API portálov umožňuje vytvoriť bohatšie používateľské prostredie na portálových stránkach Power Apps. 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 portálových stránok. Môžete napríklad vytvoriť nový obchodný vzťah, aktualizovať kontakt alebo zmeniť účet povolenia tabuľky pre produkt pomocou webového rozhrania API portálov namiesto aplikácie Správa portálu.

Poznámka

Môžete tiež použiť webové rozhranie API portálov v Power Pages. Ďalšie informácie: Čo je to Power Pages

Dôležité

  • Aby táto funkcia fungovala, musí byť vaša verzia portálu 9.3.3.x alebo novšia.
  • 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žitie webového rozhrania API portálov na integráciu s inými portálmi Power Apps 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. Celý zoznam nájdete v časti nepodporované konfiguračné tabuľky ďalej v tejto téme.
  • 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. Pamätajte, že vymazanie vyrovnávacej pamäte na strane portálového servera spôsobuje dočasné zníženie výkonu.
  • Prevádzka webového rozhrania API portálov vyžaduje licenciu portálov Power Apps. Napríklad volania webového rozhrania API uskutočnené anonymnými používateľmi 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 do zobrazení stránok nezapočítavajú, ale vyžadujú príslušné licencie. Viac informácií: Najčastejšie otázky týkajúce sa licencovania portálov Power Apps

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. Ponechali sme formát API čo najpodobnejší, aby sme znížili 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 portáloch

Poznámka

Volanie akcií a funkcií pomocou webového rozhrania API portálov 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 Description
Webapi/<table name>/enabled Povolí alebo zakáže webové rozhranie API pre <table name>.
Predvolené: False
Platné hodnoty: True, False
Webapi/<table name>/fields Definuje zoznam atribútov oddelených čiarkami, ktoré je možné upraviť pomocou webového rozhrania API.
Možné hodnoty:
- Všetky atribúty: *
- Konkrétne 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 je povinné nastavenie stránok. Ak toto nastavenie chýba, zobrazí sa chyba „Pre túto entitu nie sú definované žiadne polia“.
Webapi/error/innererror Povolí alebo zakáže InnerError.
Predvolené: False
Platné hodnoty: True, False
Webapi/<table name>/disableodatafilter Povolí alebo zakáže filter OData.
Predvolené: False
Platné hodnoty: True, False Ďalšie informácie sa dozviete 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/enabled 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.

Zabezpečenie aplikácií webového rozhrania portálov.

Overovanie požiadaviek portálov Web API

Nemusíte uvádzať overovací kód, pretože overovanie a oprávnenie sú riadené reláciou aplikácie. Všetky volania webového API musia obsahovať token CSRF (Cross-Site Request Forgery).

Pomocou EntitySetName

Pri odkaze na tabuľky Dataverse pomocou webového rozhrania API portálov vo vašom kóde musíte použiť EntitySetName, napríklad na prístup k tabuľke obchodný vzťah, syntax kódu použije EntitySetName obchodných vzťahov; /_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.

Všeobecné nariadenie o ochrane osobných údajov (GDPR)

Všetky hlavičky žiadostí budú mať kontaktné ID odovzdané na účely auditu. V prípade anonymného používateľa bude táto informácia poskytnutá ako null.

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

Denník auditovania Office 365.

Ďalšie informácie:
Aktivovanie a používanie protokolovania aktivity
Exportujte, konfigurujte a prezerajte 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 webového rozhrania API GET pre tabuľky, ktoré majú viacero úrovní oprávnení tabuľky 1 k mnohým alebo mnohé k mnohým s definovaným nadradeným rozsahom.

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

Prípadne nastavte nastavenie lokality Webapi/<table name>/disableodatafilter na True.

Dôležité

Zmena nastavenia lokality Webapi/<table name>/disableodatafilter na True môže mať za následok pomalší výkon volaní GET webového rozhrania API.

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

Pozrite si tiež

Tvorba požiadaviek HTTP a spracovanie chýb
Operácie zápisu, aktualizácie a odstránenia portálov pomocou webového rozhrania API
Kurz: Použitie webového rozhrania API portálu

Poznámka

Môžete nás informovať o svojich voľbách jazyka pre dokumentáciu? Absolvujte krátky prieskum. (upozorňujeme, že tento prieskum je v angličtine)

Prieskum bude trvať približne sedem minút. Nezhromažďujú sa žiadne osobné údaje (vyhlásenie o používaní osobných údajov).