Vytvorenie vlastného rozhrania API v Power Apps

Tento článok vysvetľuje, ako vytvoriť vlastné rozhranie API v službe Power Apps na Microsoft Dataverse pomocou riešenia. Ak chcete definovať vlastnosti požiadavky a odpovede, otestovať vlastné rozhranie API a priradiť jeho doplnok, postupujte podľa týchto krokov. Ak riešenie nepoznáte, najskôr si prečítajte tému Vytvorenie riešenia.

Vaše riešenie musí byť priradené k vydavateľovi. Vydavateľ má priradenú špecifickú predponu prispôsobenia. Predponu prispôsobenia musíte použiť pri vytváraní vlastného rozhrania API a predpona by mala byť rovnaká ako predpona, ktorú používa vydavateľ vášho riešenia. V nasledujúcich pokynoch sa táto hodnota sample používa ako predpona prispôsobenia, pretože je nastavená pre vydavateľa.

Dôležité

• Teraz je k dispozícii lepšie prostredie na vytváranie vlastného rozhrania API. Návrhára môžete použiť v rámci nástroja na registráciu doplnku. Ďalšie informácie nájdete v téme Vytvorenie vlastného rozhrania API pomocou nástroja na registráciu doplnkov.
• Po vytvorení vlastného rozhrania API nemôžete zmeniť veľa polí. Skôr než začnete, starostlivo naplánujte návrh vlastného rozhrania API. Ak sa neskôr rozhodnete, že budete musieť zmeniť tieto polia, možno budete musieť odstrániť existujúci záznam a znova vytvoriť vlastné rozhranie API. Ďalšie informácie nájdete v téme Tabuľky CustomAPI.

Vytvorenie vlastného záznamu API

1. Vosvojom riešení vyberte v rozbaľovacej ponuke>položku Nové>>ďalšie iné vlastné rozhranie API.

2. Upravte polia a nastavte vlastnosti vlastného rozhrania API. Nastavte hodnoty pre nasledujúce polia. Ďalšie informácie nájdete v téme Vlastné stĺpce tabuľky rozhrania API.

   Pred vytvorením doplnku nie je možné nastaviť hodnoty pre Typ doplnku . Túto hodnotu môžete zmeniť neskôr.

3. Vyberte Uložiť. Formulár by mal vyzerať podobne ako na nasledujúcom obrázku:

Vytvorenie parametrov požiadavky

Vlastné rozhranie API nevyžaduje parametre. Vytvorte toľko parametrov, koľko potrebujete na odovzdanie údajov potrebných pre vašu logiku.

1. Vosvojom riešení vyberte v rozbaľovacej ponuke položku >>>parameter žiadosti o vlastné rozhranie API.

2. Upravte polia a nastavte vlastnosti vlastného parametra požiadavky rozhrania API. Ďalšie informácie nájdete v téme Stĺpce tabuľky CustomAPIRequestParameter.

3. Vyberte Uložiť. Formulár by mal vyzerať podobne ako na nasledujúcom obrázku:

   

Vytvorenie vlastností odpovede

Vlastné rozhranie API, ktoré predstavuje akciu, nevyžaduje vlastnosti odpovede. Funkcia musí mať aspoň jednu. Ak je operácia úspešná, vráti úspešnú odpoveď. Ak zlyhá, vráti chybu. Definujte vlastnosti odpovede pre všetky údaje, ktoré vaše rozhranie API vráti.

Ak definujete iba jednu vlastnosť entity alebo entityCollection , odpoveď je tohto typu. Ak definujete viacero vlastností alebo jednu alebo viacero vlastností jednoduchého typu, rozhranie API vráti zložitý typ, v ktorom je každá vlastnosť odpovede vlastnosťou tohto komplexného typu.

Ak má sample_CustomAPIExamplenapríklad vaše vlastné rozhranie API jedinečný názov , vráti komplexný typ s názvom sample_CustomAPIExampleResponse s vlastnosťami pre každú definovanú vlastnosť odpovede.

1. Vo svojom riešení vyberte v rozbaľovacom zozname položku>>>vlastnosť inej vlastnej odpovede rozhrania API.

2. Upravte polia a nastavte vlastnosti vlastnej vlastnosti rozhrania API response. Ďalšie informácie nájdete v téme Stĺpce tabuľky CustomAPIResponseProperty.

3. Vyberte Uložiť. Formulár by mal vyzerať podobne ako na nasledujúcom obrázku:

   

Dodržujte výsledok v servisnom dokumente

Ak nenastavíte vlastnosť vlastného IsPrivate rozhrania API, môžete načítať definíciu služby z dokumentu CSDL $metadata pomocou GET požiadavky, a to aj z vášho prehliadača. Ak je URL adresa vášho prostredia https://yourorg.crm.dynamics.com, môžete túto URL adresu zadať do poľa adresy prehliadača a načítať $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Vo výsledku vyhľadajte názov vlastného rozhrania API. Rozhranie API definované pomocou predchádzajúcich krokov napríklad vyzerá 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>

Testovanie vlastného rozhrania API

Po vytvorení vlastného rozhrania API si ho môžete vyskúšať. Dokonca aj keď nenastavíte typ doplnku na definovanie hlavnej operácie, môžete ju teraz otestovať, či sa dá zavolať správne. Všetky vlastnosti odpovede vrátia svoju predvolenú hodnotu, napríklad null. Ďalšie informácie nájdete v téme Vyvolanie vlastných rozhraní API.

Aktualizácia vlastného doplnku rozhrania API

Informácie o tom, ako napísať doplnok pre vlastné rozhranie API, nájdete v téme Písanie doplnku pre vlastné rozhranie API.

Po registrácii zostavy musíte nastaviť hodnotu Typ doplnku pre vlastné rozhranie API, ktoré ste vytvorili. Táto hodnota je vlastnosť vyhľadávania, takže stačí nájsť Typ doplnku, ktorý predstavuje typ vytvorený pri registrácii zostavy.

Po nastavení typu doplnku môžete otestovať vlastné rozhranie API a overiť, či sú vrátené správne výsledky.

Ďalšie spôsoby vytvárania vlastných rozhraní API

Nástroj na registráciu doplnkov poskytuje vlastného návrhára API. Ďalšie informácie nájdete v téme Vytvorenie vlastného rozhrania API pomocou nástroja na registráciu doplnkov.

Možno máte požiadavky na vytvorenie klientskej aplikácie, ktorá umožňuje vytváranie vlastných rozhraní API mimo návrhára. Keďže údaje pre vlastné rozhrania API sú uložené v tabuľkách, môžete ich vytvárať pomocou kódu. Ďalšie informácie nájdete v téme Vytvorenie vlastného rozhrania API s kódom.

Vášmu procesu ALM môže lepšie slúžiť vytváranie vlastných rozhraní API úpravou súborov riešení. Ďalšie informácie nájdete v téme Vytvorenie vlastného rozhrania API so súbormi riešení.

Pozrite si tiež

Vytváranie a používanie vlastných rozhraní API
Vytvorenie vlastného rozhrania API pomocou nástroja na registráciu doplnkov
Vytvorenie vlastného rozhrania API s kódom
Vytvorenie vlastného rozhrania API so súbormi riešení
Vytváranie vlastných správ