Ustvarjanje API-ja po meri v storitvi Power Apps

V tem članku je razloženo, kako ustvarite API po meri Power Apps za Microsoft Dataverse z rešitvijo. Upoštevajte ta navodila, da določite lastnosti zahteve in odgovora, preskusite API po meri in povežete njegovo vrsto vtičnika. Č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 prilagoditve, ta predpona pa mora biti ista predpona, ki jo uporablja izdajatelj 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. Če želite več informacij, glejte Ustvarjanje VMESNIKA API po meri z orodjem za registracijo vtičnika.
• Ko ustvarite vmesnik API po meri, ne morete spremeniti več polj, povezanih z ustvarjanjem api-ja po meri. Pred začetkom natančno načrtujte načrt VMESNIKA API po meri. Če se pozneje odločite, da boste morali spremeniti ta polja, boste morda morali izbrisati obstoječi zapis in znova ustvariti API po meri. Če želite več informacij, glejte Tabele CustomAPI.

Ustvarjanje zapisa API-ja po meri

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

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

   Vrednosti za Vrsta vtičnika ne morete nastaviti, preden ustvarite vtičnik. To vrednost lahko spremenite pozneje.

3. Izberite možnost Shrani. Obrazec bi moral biti podoben tej sliki: Posnetek zaslona shranjenega

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 izberite>>>parameter zahteve API-ja po meri.

2. Uredite polja, če želite nastaviti lastnosti parametra zahteve za API po meri. Če želite več informacij, glejte Stolpci tabele CustomAPIRequestParameter.

3. Izberite možnost Shrani. Obrazec bi moral biti podoben tej sliki:

   

Ustvarjanje 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 API.

Če določite le eno lastnost odgovora »Entity« ali »EntityCollection«, je odgovor te vrste. Če določite več lastnosti ali eno ali več lastnosti preprostega tipa, API vrne kompleksno vrsto, kjer je vsaka lastnost odziva lastnost te kompleksne vrste.

Če je na primer enolično ime API-ja po meri sample_CustomAPIExample, sample_CustomAPIExampleResponse vrne kompleksno vrsto z lastnostmi za vsako lastnost odziva, ki jo določite.

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

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

3. Izberite možnost Shrani. Obrazec bi moral biti podoben tej sliki:

   

Upoštevajte rezultat v vročevalnem dokumentu

Če ne nastavite lastnosti IsPrivate za API po meri, lahko definicijo storitve pridobite iz dokumenta CSDL $metadata zGET zahtevo, tudi iz brskalnika. Če je URL za vaše okolje https://yourorg.crm.dynamics.com, 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, določen z uporabo prejšnjih korakov, 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 preskusite. Tudi če ne nastavite vrste vtičnika za določanje glavnega postopka, ga lahko preskusite zdaj in preverite, ali ga lahko pravilno pokličete. Vse lastnosti odgovora vrnejo privzeto vrednost, na primer null. Če želite več informacij, glejte Priklic API-jev po meri.

Posodobite vrsto vtičnika API 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. Ta vrednost je lastnost za iskanje, zato morate le poiskati vrsto vtičnika, ki predstavlja vrsto, ki je bila ustvarjena, ko ste registrirali zbir.

Ko nastavite vrsto vtičnika, lahko preskusite 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. Če želite več informacij, glejte Ustvarjanje VMESNIKA API po meri z orodjem za registracijo vtičnika.

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. Če želite več informacij, glejte Ustvarjanje VMESNIKA API po meri s kodo.

Vaš postopek ALM bo morda boljši z ustvarjanjem API-jev po meri z urejanjem datotek rešitev. Če želite več informacij, glejte Ustvarjanje vmesnika API 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