Ustvarjanje API-ja po meri v storitvi Power Apps

Pri ustvarjanju API-ja po meri morate uporabiti rešitev. Če ne poznate rešitev, najprej preberite Ustvarjanje rešitve.

Rešitev mora biti povezana z založnikom. Založnik ima z njim povezano določeno predpono prilagajanja. Pri ustvarjanju API-ja po meri morate uporabiti predpono za prilagajanje in ta predpona mora biti enaka tisti, ki jo uporablja založnik vaše rešitve. V spodnjih navodilih je vrednost sample uporabljena kot predpona prilagajanja, ker je nastavljena za založnika.

Pomembno

• Zdaj je na voljo boljša izkušnja za ustvarjanje API-ja po meri. Oblikovalca lahko uporabite v orodju za registracijo vtičnikov. Več informacij: Ustvarjanje API-ja po meri z orodjem za registracijo vtičnikov
• Številnih polj, povezanih z ustvarjanjem API-ja po meri, ni mogoče spremeniti, ko jih ustvarite. Preden začnete, morate skrbno načrtovati zasnovo API-ja po meri. Če se pozneje odločite, da morate spremeniti stvari, ko ustvarite API po meri, boste morda morali izbrisati obstoječi zapis in znova ustvariti API po meri. Tukaj si oglejte informacije o stolpcih, ki jih ni mogoče spremeniti: Tabele CustomAPI

Ustvarjanje zapisa API-ja po meri

1. V svoji rešitvi v spustnem meniju izberiteNov>več>>drugih API-jev po meri.

2. Uredite polja, da nastavite lastnosti API-ja po meri. Nastavite morate vrednosti za naslednja polja. Če želite več informacij, glejte Stolpci tabele API-ja po meri

   Vrednosti za Vrsta vtičnika ne morete nastaviti, preden ustvarite vtičnik. Pozneje ga lahko spremenite.

3. Izberite možnost Shrani. Obrazec mora biti videti nekako tako:

Ustvarjanje parametrov zahteve

API po meri ne zahteva parametrov. Ustvarite toliko parametrov, kot jih potrebujete za posredovanje podatkov, potrebnih za vašo logiko.

1. V rešitvi v spustnem meniju izberiteNov>drugi>>parameter zahteve API-ja po meri.

2. Uredite polja, da nastavite lastnosti parametra zahteve API-ja po meri. Če želite več informacij, glejte Stolpci tabele CustomAPIRequestParameter

3. Izberite možnost Shrani. Obrazec naj bo videti nekako tako:

   

Ustvarite lastnosti odgovora

API po meri, ki predstavlja dejanje, ne zahteva lastnosti odziva. Funkcija mora imeti vsaj eno. Če je operacija uspešna, vrne odziv na uspeh. Če ne uspe, vrne napako. Določite lastnosti odgovora za vse podatke, ki jih vrne vaš API.

Če je določena samo ena lastnost odgovora Entity ali EntityCollection , je odgovor te vrste. Če obstaja več lastnosti ali ena ali več lastnosti preprostega tipa, API vrne kompleksen tip, kjer je vsaka lastnost odziva lastnost tega kompleksnega tipa.

Če je na primer enolično ime API-ja po meri , sample_CustomAPIExamplevrne zapleten tip, poimenovan sample_CustomAPIExampleResponse z lastnostmi za vsako lastnost odgovora, ki jo določite.

1. V svoji rešitvi na spustnemseznamu izberite Novo>več>>drugih lastnosti odziva API-ja po meri.

2. Uredite polja, da nastavite lastnosti lastnosti odgovora API-ja po meri. Če želite več informacij, glejte Stolpci tabele CustomAPIResponseProperty

3. Izberite možnost Shrani. Obrazec naj bo videti nekako tako:

   

Upoštevajte rezultat v vročevalnem dokumentu

Če lastnosti za API po meri še niste nastavili IsPrivate , lahko zdaj z zahtevo pridobite definicijo storitve iz $metadata dokumenta CSDL , tudi iz brskalnika GET . Če je https://yourorg.crm.dynamics.comURL za vaše okolje , lahko ta URL vnesete v polje z naslovom brskalnika, da pridobite $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Poiščite ime API-ja po meri. API, definiran z zgornjimi koraki, je na primer videti tako:

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

Preizkušanje API-ja po meri

Ko ustvarite API po meri, ga lahko poskusite. Tudi če niste nastavili vrste vtičnika za določanje glavne operacije, jo lahko zdaj preizkusite in preverite, ali jo lahko pravilno pokličete. Vse lastnosti odgovora vrnejo privzeto vrednost, na primer null. Več informacij: Klicanje API-jev po meri.

Posodobitev vrste vtičnika API-ja po meri

Če želite več informacij o tem, kako napisati vtičnik za API po meri, glejte Pisanje vtičnika za API po meri.

Ko registrirate sklop, morate nastaviti vrednost Vrsta vtičnika za API po meri, ki ste ga ustvarili. To je lastnost iskanja, zato morate le poiskati vrsto vtičnika, ki predstavlja vrsto, ustvarjeno ob registraciji zbirke.

Ko nastavite vrsto vtičnika, lahko preizkusite API po meri, da preverite, ali so vrnjeni pravilni rezultati.

Drugi načini ustvarjanja API-jev po meri

Orodje za registracijo vtičnikov ponuja oblikovalnik API-ja po meri. Več informacij: Ustvarjanje API-ja po meri z orodjem za registracijo vtičnikov

Morda boste imeli zahteve za ustvarjanje odjemalske aplikacije, ki omogoča ustvarjanje API-jev po meri zunaj oblikovalnika. Ker so podatki za API-je po meri shranjeni v tabelah, jih lahko ustvarite s kodo. Več informacij: Ustvarjanje API-ja po meri s kodo.

Vaš postopek ALM bo morda boljši z ustvarjanjem API-jev po meri z urejanjem datotek rešitev. Več informacij: Ustvarjanje API-ja po meri z datotekami rešitev.

Glejte tudi

Ustvarite in uporabite API-je po meri
Ustvarjanje API-ja po meri z orodjem za registracijo vtičnikov
Ustvarjanje API-ja po meri s kodo
Ustvarjanje API-ja po meri z datotekami rešitev
Ustvarjanje lastnih sporočil