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

Při vytváření vlastního rozhraní API musíte použít řešení. 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 ta 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: Vytvoření vlastního rozhraní API pomocí nástroje pro registraci modulů plug-in
• Mnoho polí souvisejících s vytvářením vlastního rozhraní API se po vytvoření nedá změnit. Než začnete, měli byste pečlivě naplánovat návrh vlastního rozhraní API. Pokud se později rozhodnete, že budete muset po vytvoření vlastního rozhraní API změnit věci, možná budete muset odstranit existující záznam a znovu vytvořit vlastní rozhraní API. Projděte si informace o sloupcích, které nejde změnit tady: 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. Je nutné nastavit hodnoty pro následující pole. Další informace najdete ve sloupcích tabulky vlastních rozhraní API.

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

3. Vyberte Uložit. Formulář by měl vypadat přibližně takto:

Vytvoření libovolných 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 Table Columns

3. Vyberte Uložit. Formulář by měl vypadat přibližně takto:

   

Vytvořte jakékoliv vlastnosti 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. Vlastnosti odpovědi byste měli definovat pro všechna data, která vaše rozhraní API vrací.

Pokud je definována pouze jedna vlastnost odpovědi Entity nebo EntityCollection , je odpověď tohoto typu. Pokud existuje více vlastností nebo jedné 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 vlastního rozhraní API sample_CustomAPIExample, vrátí komplexní typ sample_CustomAPIExampleResponse s vlastnostmi 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 parametry vlastního atributu odpovědi API. Další informace si můžete přečíst v tématu CustomAPIResponseProperty Table Columns

3. Vyberte Uložit. Formulář by měl vypadat přibližně takto:

   

Pozorujte výsledek v dokumentu služby

Pokud jste nenastavili vlastnost pro vaše vlastní IsPrivate rozhraní API, můžete nyní načíst definici služby z dokumentu $metadata CSDL pomocí GET požadavku, dokonce 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í výše uvedený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ž jste nenastavili 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: Vyvolání vlastních rozhraní API

Aktualizujte vlastní typ pluginu pro 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. Toto je vyhledávací vlastnost, takže stačí najít typ plug-inu, který představuje typ vytvořený při registraci sestavení.

Jakmile nastavíte typ 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: 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: 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: 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