Přehled webového rozhraní API portálů
Webové rozhraní API portálů umožňuje bohatší uživatelské prostředí uvnitř webů Power Pages. Webové rozhraní API můžete použít k vytváření, čtení, aktualizaci a odstraňování operací napříč všemi tabulkami Microsoft Dataverse na vašich webových stránkách. S pomocí webového rozhraní API portálů můžete například vytvořit nový obchodní vztah nebo aktualizovat kontakt, aniž byste použili formulář nebo formulář s více kroky.
Důležité
- Aby tato funkce fungovala, musí být verze webu Power Pages 9.3.3.x nebo novější.
- Webové rozhraní API je určené k vytváření bohatšího uživatelské prostředí uvnitř stránek portálů. Není optimalizováno pro služby třetích stran nebo integraci aplikací. Použití webového rozhraní API portálu k integraci s jinými weby Power Pages také není podporováno.
- Operace webového rozhraní API portálu jsou omezeny na tabulky související s daty – například s obchodními vztahy, kontakty nebo vlastnímu tabulkami. Konfigurace metadat tabulky nebo dat konfigurační tabulky portálu – například konfigurace tabulek portálů, jako je adx_contentsnippet, adx_entityform nebo adx_entitylist – není podporována webovým rozhraním API portálu. Úplný seznam najdete v části o nepodporovaných konfiguračních tabulkách dále v tomto tématu.
- Webové rozhraní API portálů těží z ukládání do mezipaměti na straně serveru, takže následná volání webového rozhraní API jsou rychlejší než počáteční volání. Berte na vědomí, že vymazání mezipaměti na straně portálového serveru způsobí dočasné snížení výkonu.
- Operace webového rozhraní API portálů vyžadují licenci Power Pages. Například volání webového rozhraní API provedená anonymními uživateli se započítávají do kapacity anonymního uživatele. Volání webového rozhraní API prováděná ověřenými uživateli (interními nebo externími) se do zobrazení stránky nezapočítávají, ale vyžadují příslušné licence kapacity ověřeného uživatele. Další informace: Nejčastější dotazy k licencování Power Pages
Operace webového rozhraní API
Portály webového rozhraní API nabízejí podmnožinu funkcí pro operace Dataverse, které můžete provést pomocí rozhraní API Dataverse. Ponechali jsme formát API co nejpodobnější, abychom usnadnili učení.
Poznámka:
Operace webového rozhraní API rozlišují velká a malá písmena.
Operace webových rozhraní API dostupné v Power Pages
- Čtení záznamů z tabulky
- Vytvoření záznamu v tabulce
- Aktualizace a odstranění záznamů v tabulce
- Přidružení a zrušení přidružení tabulek
Nastavení webu pro webové rozhraní API
Chcete-li na svém portálu povolit webové rozhraní API portálů, musíte povolit nastavení webu. Můžete také nakonfigurovat webové rozhraní API na úrovni polí, které bude určovat pole tabulek, která lze nebo nelze upravit pomocí webového rozhraní API portálu.
Poznámka:
U těchto nastavení (např. účet) používejte logický název tabulky.
| Název nastavení webu | Description |
|---|---|
| Webapi/<název tabulky>/enabled | Povolí nebo zakáže webové rozhraní API pro <název tabulky>. Výchozí: False Platné hodnoty: True, False |
| Webapi/<název tabulky>/fields | Definuje seznam atributů oddělených čárkami, které lze upravit pomocí webového rozhraní API. Možné hodnoty: - Všechny atributy: * - Konkrétní atributy: attr1,attr2,attr3 Poznámka: Hodnota musí být buď hvězdička (*) nebo seznam názvů polí oddělených čárkami. Důležité: Toto je povinné nastavení webu. Pokud toto nastavení chybí, zobrazí se chyba „Pro tuto entitu nejsou definována žádná pole“. |
| Webapi/error/innererror | Povolí nebo zakáže InnerError. Výchozí: False Platné hodnoty: True, False |
| Webapi/<název tabulky>/disableodatafilter | Aktivuje nebo deaktivuje filtr OData. Výchozí: False Platné hodnoty: True, False Další informace viz známé problémy. Nastavení webu je dostupné ve verzi portálu 9.4.10.74 a novější. |
Poznámka:
Nastavení webu musí být nastaveno na Aktivní, aby se změny projevily.
Například k vystavení webového rozhraní API pro tabulku Případ, kde mohou ověření uživatelé provádět operace vytváření, aktualizace a odstranění na této entitě, je nastavení webu zobrazeno v následující tabulce.
| Název nastavení webu | Hodnota nastavení webu |
|---|---|
| Webapi/incident/enabled | pravda |
| Webapi/incident/fields | attr1, attr2, attr3 |
Zabezpečení pomocí webového rozhraní API portálů
Zabezpečení založené na záznamech můžete nakonfigurovat pro jednotlivé záznamy v portálech pomocí oprávnění k tabulkám. Webové rozhraní API portálů přistupuje k záznamům tabulek (entit) a řídí se oprávněními k tabulce udělenými uživatelům prostřednictvím přidružených webové role.
Můžete konfigurovat oprávnění sloupců k další definici oprávnění k jednotlivým sloupcům v tabulce při použití webového rozhraní API portálu.
Ověřování požadavků webového rozhraní API portálů
Nemusíte zadávat ověřovací kód, protože ověření a autorizaci spravuje relace aplikace. Všechna volání webového API musí obsahovat token Cross-Site Request Forgery (CSRF).
Používání vlastnosti EntitySetName
Při odkazu na tabulky Dataverse s využitím Web API portálu musíte použít EntitySetName, například pro přístup k tabulce Account použije syntaxe kódu název EntitySetName accounts ;/_api/accounts().
Poznámka:
U nastavení webu (např. účet) používejte logický název tabulky.
Vlastnost EntitySetName konkrétních tabulek můžete určit takto:
Přejít na https://make.powerapps.com
Vyberte kartu Dataverse v bočním panelu a vyberte tabulku.
Vyberte položku ... (možnost Příkazy) a poté vyberte Upřesnit, Nástroje a Kopírovat název sady, aby se vlastnost EntitySetName tabulky zkopírovala do schránky.
Zákony a předpisy na ochranu osobních údajů
Všechna záhlaví požadavků bude mít ID kontaktu předané pro účely auditu. U anonymního uživatele to bude předáno jako null.
Pokud je povoleno protokolování auditu, může uživatel zobrazit všechny události auditu v protokolu auditu Office 365.
Další informace:
Povolení a použití protokolování aktivit
Export, konfigurace a zobrazení záznamů protokolu auditu
Nepodporované konfigurační tabulky
Webové rozhraní API portálů nelze použít pro následující konfigurační tabulky:
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ámé problémy
Uživatelé obdrží chybu CDS, pokud vyvolají požadavek webového rozhraní API GET pro tabulky, které mají několik úrovní oprávnění 1:N nebo N:N, když rozsahy Nadřazený, Kontakt nebo Obchodní vztah přidávají k dotazu další podmínky.
Chcete-li tento problém vyřešit, je doporučeným řešením použít FetchXML v dotazu OData.
Případně nastavte nastavení webu Webapi/<název tabulky>/disableodatafilter na True.
Důležité
Změna nastavení webu Webapi/<název tabulky>/disableodatafilter na True může mít za následek pomalejší výkon volání GET webového rozhraní API.
Nastavení webu je dostupné ve verzi portálu 9.4.10.74 a novější.
Další krok
Dotazování na data pomocí webového rozhraní API portálů