Vytvoření vlastního rozhraní API v Power Apps

Tento článek vysvětluje, jak vytvořit vlastní rozhraní API v Power Apps pro Microsoft Dataverse pomocí řešení. Pomocí těchto kroků definujte vlastnosti požadavku a odpovědi, otestujte vlastní rozhraní API a přidružte jeho typ modulu plug-in. Pokud řešení neznáte, přečtěte si nejprve článek Vytvoření řešení.

Vaše řešení musí být přidružené k vydavateli. Vydavatel má přidruženou konkrétní předponu vlastního nastavení. Při vytváření vlastního rozhraní API musíte použít předponu vlastního nastavení a tato předpona by měla být stejná jako předpona používaná vydavatelem vašeho řešení. Následující pokyny používají hodnotu sample jako předponu přizpůsobení, protože ta je nastavena pro vydavatele.

Důležité

  • Teď je k dispozici lepší prostředí pro vytváření vlastních rozhraní API. Návrháře můžete použít v nástroji pro registraci modulů plug-in. Další informace najdete v tématu Vytvoření vlastního rozhraní API pomocí nástroje pro registraci modulů plug-in.
  • Po vytvoření nemůžete změnit mnoho polí souvisejících s vytvořením vlastního rozhraní API. Před zahájením pečlivě naplánujte návrh vlastního rozhraní API. Pokud se později rozhodnete, že budete muset tato pole změnit, možná budete muset odstranit existující záznam a znovu vytvořit vlastní rozhraní API. Další informace najdete v tématu Tabulky CustomAPI.

Vytvoření vlastního záznamu rozhraní API

  1. V řešení vyberte v rozevíracím seznamu Nový>Více>Další>vlastní rozhraní API.

  2. Upravte pole a nastavte vlastnosti vlastního rozhraní API. Nastavte hodnoty pro následující pole. Další informace najdete v tématu Sloupce vlastní tabulky rozhraní API.

    Před vytvořením modulu plug-in nemůžete nastavit hodnoty pro typ modulu plug-in. Tuto hodnotu můžete později změnit.

  3. Vyberte Uložit. Váš formulář by měl vypadat podobně jako na následujícím obrázku: Snímek obrazovky uloženého vlastního formuláře rozhraní API s nakonfigurovanými vlastnostmi.

Vytvoření parametrů požadavku

Vlastní rozhraní API nevyžaduje parametry. Vytvořte tolik parametrů, kolik potřebujete k předání dat potřebných pro vaši logiku.

  1. V rámci vašeho řešení vyberte z rozevíracího seznamu Nový>Další>Jiný>Parametr vlastního požadavku API.

  2. Upravte pole a nastavte vlastnosti vlastního parametru požadavku rozhraní API. Další informace naleznete v tématu CustomAPIRequestParameter Sloupce tabulky.

  3. Vyberte Uložit. Formulář by měl vypadat podobně jako na následujícím obrázku:

    Snímek obrazovky s ukázkovým formulářem parametru požadavku vlastního rozhraní API

Vytvoření vlastností odpovědi

Vlastní rozhraní API, které představuje akci, nevyžaduje vlastnosti odpovědi. Funkce musí mít aspoň jednu. Pokud je operace úspěšná, vrátí odpověď signalizující úspěch. Pokud selže, vrátí chybu. Definujte vlastnosti odpovědi pro všechna data, která vaše rozhraní API vrací.

Pokud definujete pouze jednu entitu nebo vlastnost odpovědi EntityCollection , je odpověď tohoto typu. Pokud definujete více vlastností nebo jednu nebo více vlastností jednoduchého typu, vrátí rozhraní API komplexní typ, kde každá vlastnost odpovědi je vlastností tohoto komplexního typu.

Pokud je například jedinečný název sample_CustomAPIExamplevašeho vlastního rozhraní API, vrátí komplexní typ s vlastnostmi sample_CustomAPIExampleResponse pro každou vlastnost odpovědi, kterou definujete.

  1. V řešení vyberte v rozevíracím seznamu Nová>Další>Ostatní>vlastní vlastnost odpovědi rozhraní API.

  2. Upravte pole a nastavte vlastnosti vlastní vlastnosti odpovědi rozhraní API. Další informace naleznete v tématu CustomAPIResponseProperty Table Columns.

  3. Vyberte Uložit. Formulář by měl vypadat podobně jako na následujícím obrázku:

    Snímek obrazovky s ukázkovým formulářem vlastní vlastnosti odpovědi rozhraní API

Pozorujte výsledek v dokumentu služby

Pokud vlastnost vlastního IsPrivate rozhraní API nenastavíte, můžete definici služby načíst z dokumentu CSDL $metadata pomocí GET požadavku, a to i z prohlížeče. Pokud je https://yourorg.crm.dynamics.comadresa URL vašeho prostředí , můžete tuto adresu URL zadat do pole adresy prohlížeče a načíst $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Prohledejte výsledek, abyste zjistili název vlastního rozhraní API. Například rozhraní API definované pomocí předchozích kroků vypadá takto:

<ComplexType Name="sample_CustomAPIExampleResponse">
    <Property Name="StringProperty" Type="Edm.String" Unicode="false" />
</ComplexType>
<Action Name="sample_CustomAPIExample">
    <Parameter Name="StringParameter" Type="Edm.String" Nullable="false" Unicode="false" />
    <ReturnType Type="mscrm.sample_CustomAPIExampleResponse" Nullable="false" />
</Action>

Testování vlastního rozhraní API

Po vytvoření vlastního rozhraní API ho můžete vyzkoušet. I když nenastavíte typ modulu plug-in pro definování hlavní operace, můžete ho otestovat a ověřit, že ho můžete volat správně. Všechny vlastnosti odpovědi vrátí výchozí hodnotu, například null. Další informace najdete v tématu Vyvolání vlastních rozhraní API.

Aktualizace vlastního typu modulu plug-in rozhraní API

Informace o tom, jak napsat modul plug-in pro vlastní rozhraní API, najdete v tématu Zápis modulu plug-in pro vlastní rozhraní API.

Po registraci sestavení musíte nastavit hodnotu Typ modulu plug-in pro vlastní rozhraní API, které jste vytvořili. Tato hodnota je vyhledávací vlastnost, takže stačí najít typ modulu plug-in, který představuje typ vytvořený při registraci sestavení.

Snímek obrazovky s vyhledáváním použitým k nastavení vlastního typu modulu plug-in api

Po nastavení typu modulu plug-in můžete otestovat vlastní rozhraní API a ověřit vrácení správných výsledků.

Další způsoby vytváření vlastních rozhraní API

Nástroj pro registraci modulů plug-in poskytuje vlastního návrháře rozhraní API. Další informace najdete v tématu Vytvoření vlastního rozhraní API pomocí nástroje pro registraci modulů plug-in.

Možná budete potřebovat vytvořit klientskou aplikaci, která umožňuje vytvářet vlastní rozhraní API mimo návrháře. Vzhledem k tomu, že data pro vlastní rozhraní API jsou uložená v tabulkách, můžete je vytvořit pomocí kódu. Další informace najdete v tématu Vytvoření vlastního rozhraní API s kódem.

Proces ALM může být lépe obsluhován vytvořením vlastních rozhraní API úpravou souborů řešení. Další informace najdete v tématu Vytvoření vlastního rozhraní API se soubory řešení.

Viz také

Vytvoření a použití vlastních rozhraní API
Vytvoření vlastního rozhraní API pomocí nástroje pro registraci modulů plug-in
Vytvoření vlastního rozhraní API pomocí kódu
Vytvoření vlastního rozhraní API se soubory řešení
Vytváření vlastních zpráv

  • Last updated on