Sdílet prostřednictvím


Přehled webového rozhraní API portálů

Poznámka

S účinností od 12. října 2022 jsou portály Power Apps Power Pages. Další informace: Služba Microsoft Power Pages je nyní obecně dostupná (blog)
Zanedlouho migrujeme a sloučíme dokumentaci k portálům Power Apps s dokumentací k Power Pages.

Webové rozhraní API portálů umožňuje bohatší uživatelské prostředí uvnitř stránek portálů Power Apps. Webové rozhraní API můžete použít k vytváření, čtení, aktualizaci a odstraňování operací napříč všemi tabulkami Microsoft Dataverse ze stránek vašich portálů. Můžete například vytvořit nový obchodní vztah, aktualizovat kontakt nebo změnit oprávnění k tabulkám pro produkt pomocí webového rozhraní API portálů místo aplikace Správa portálu.

Poznámka

Webové rozhraní API můžete používat také v Power Pages. Další informace: Co jsou Power Pages

Důležité

  • Aby tato funkce fungovala, musí být vaše verze portálu 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 API portálů k integraci s ostatními weby portálu Power Apps také není možné.
  • 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í licence portálů Power Apps. Například volání webového rozhraní API provedená anonymními uživateli se započítávají do kapacity zobrazení stránky. 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. Více informací: Časté dotazy k licencování portálů Power Apps

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é na portálech

Poznámka

Volání akcí a funkcí pomocí webového rozhraní API portálu není podporováno.

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/<table name>/enabled Povolí nebo zakáže webové rozhraní API pro <table name>.
Výchozí: False
Platné hodnoty: True, False
Webapi/<table name>/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/<table name>/disableodatafilter Aktivuje nebo deaktivuje filtr OData.
Výchozí: False
Platné hodnoty: True, False. Další informace najdete v tématu 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.

Zabezpečení webového rozhraní API portálů.

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:

  1. Přejděte na web https://make.powerapps.com

  2. Vyberte kartu Dataverse v bočním panelu a vyberte tabulku.

  3. 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.

    Jak najít EntitySetName tabulky Dataverse.

Obecné nařízení o ochraně osobních údajů (GDPR)

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.

Protokol 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í více úrovní oprávnění k tabulce 1 k mnoha nebo mnoho k mnoha s definovaným rozsahem nadřazený.

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/<table name>/disableodatafilter na True.

Důležité

Změna nastavení webu Webapi/<table name>/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ů

Viz také

Sestavování požadavků HTTP a ošetření chyb
Operace portálu pro zápis, aktualizaci a odstranění entit pomocí webového rozhraní API
Kurz: Použití webového rozhraní API portálu

Poznámka

Můžete nám sdělit, jaké máte jazykové preference pro dokumentaci? Zúčastněte se krátkého průzkumu. (upozorňujeme, že tento průzkum je v angličtině)

Průzkum bude trvat asi sedm minut. Nejsou shromažďovány žádné osobní údaje (prohlášení o zásadách ochrany osobních údajů).