Kohandatud API loomine Power Appsis

Kohandatud API loomisel peate kasutama lahendust. Kui te pole lahendustega tuttav, lugege esmalt artiklit Lahenduse loomine.

Teie lahendus peab olema seostatud avaldajaga. Väljaandjal on sellega seotud konkreetne kohandamise eesliide. Kohandatud API loomisel peate kasutama kohandamise eesliidet ja see eesliide peaks olema sama, mida kasutab teie lahenduse väljaandja. Järgmistes juhistes kasutatakse väärtust sample kohandamise eesliitena, kuna see on väljaandja jaoks määratud.

Oluline

• Nüüd on kohandatud API loomiseks parem kogemus. Kujundajat saate kasutada lisandmooduli registreerimise tööriistas. Lisateave: Kohandatud API loomine lisandmooduli registreerimistööriista abil
• Paljusid kohandatud API loomisega seotud välju ei saa pärast nende loomist muuta. Enne alustamist peaksite kohandatud API kujunduse hoolikalt planeerima. Kui otsustate hiljem, et peate pärast kohandatud API loomist asju muutma, peate võib-olla kustutama olemasoleva kirje ja looma kohandatud API uuesti. Vaadake siin üle teave veergude kohta, mida ei saa muuta. CustomAPI tabelid

Kohandatud API kirje loomine

1. Valige oma lahenduses rippmenüüst Uus>Veel>muud>kohandatud API.

2. Redigeerige välju, et määrata oma kohandatud API atribuudid. Peate määrama väärtused järgmistele väljadele. Lisateavet leiate teemast Kohandatud API tabeli veerud

   Enne lisandmooduli loomist ei saa lisandmooduli tüübi väärtusi määrata. Saate seda hiljem muuta.

3. Valige käsk Salvesta. Teie vorm peaks välja nägema umbes selline:

Looge mis tahes päringu parameetrid

Kohandatud API ei nõua parameetreid. Looge nii palju parameetreid, kui vajate oma loogika jaoks vajalike andmete edastamiseks.

1. Valige oma lahenduses rippmenüüst Uus>Veel>muud>kohandatud API taotluse parameeter.

2. Redigeerige välju, et määrata kohandatud API päringu parameetri atribuudid. Lisateavet leiate teemast CustomAPIRequestParameter tabeli veerud

3. Valige käsk Salvesta. Teie vorm peaks välja nägema umbes selline:

   

Looge mis tahes vastuse atribuudid

Toimingut tähistav kohandatud API ei nõua vastuse atribuute. Funktsioonil peab olema vähemalt üks. Kui toiming õnnestub, tagastab see eduka vastuse. Kui see ebaõnnestub, tagastab see vea. Peaksite määratlema vastuse atribuudid kõigi andmete jaoks, mida teie API tagastab.

Kui on määratletud ainult üks vastuse atribuut Olem või Olemikogu, on vastus seda tüüpi. Kui atribuute on mitu või üks või mitu lihtsat tüüpi atribuuti, tagastab API komplekstüübi, kus iga vastuse atribuut on selle kompleksse tüübi atribuut.

Näiteks kui teie kohandatud API kordumatu nimi on sample_CustomAPIExample, tagastab see keeruka tüübi, mille nimi on sample_CustomAPIExampleResponse iga teie määratletud vastuseatribuudi atribuutidega.

1. Valige oma lahenduses rippmenüüst Uus>Veel>muud>kohandatud API vastuse atribuuti.

2. Redigeerige välju, et määrata kohandatud API vastuse atribuudi atribuudid. Lisateavet leiate teemast CustomAPIResponseProperty tabeli veerud

3. Valige käsk Salvesta. Teie vorm peaks välja nägema umbes selline:

   

Jälgige tulemust kättetoimetamisdokumendis

Kui te pole oma kohandatud API atribuuti määranud IsPrivate , saate nüüd teenuse definitsiooni CSDL-i $metadata dokumendist päringu abil GET hankida, isegi oma brauserist. Kui teie keskkonna URL on https://yourorg.crm.dynamics.com, saate tippida selle URL-i brauseri aadressiväljale, et tuua $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Otsige tulemist, et leida kohandatud API nimi. Näiteks ülaltoodud sammude abil määratletud API näeb välja selline:

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

Testige oma kohandatud API-d

Pärast kohandatud API loomist saate seda proovida. Isegi kui te pole põhitoimingu määratlemiseks lisandmooduli tüüpi määranud, saate seda nüüd testida, et veenduda, kas saate seda õigesti kutsuda. Kõik vastuse atribuudid tagastavad vaikeväärtuse (nt null). Lisateave: Kohandatud API-de käivitamine.

Kohandatud API pistikprogrammi tüübi värskendamine

Lisateavet kohandatud API jaoks lisandmooduli kirjutamise kohta leiate teemast Kohandatud API jaoks lisandmooduli kirjutamine.

Pärast koostu registreerimist peate määrama loodud kohandatud API jaoks väärtuse Plugina tüüp . See on otsinguatribuut, nii et peate lihtsalt leidma lisandmooduli tüübi, mis tähistab koostu registreerimisel loodud tüüpi.

Kui olete pistikprogrammi tüübi määranud, saate testida oma kohandatud API-d, et kontrollida, kas tagastatakse õiged tulemused.

Muud võimalused kohandatud API-de loomiseks

Pistikprogrammi registreerimise tööriist pakub kohandatud API kujundajat. Lisateave: Kohandatud API loomine lisandmooduli registreerimistööriista abil

Teil võib olla nõudeid luua klientrakendus, mis võimaldab luua kohandatud API-sid väljaspool kujundajat. Kuna kohandatud API-de andmed talletatakse tabelites, saate neid koodi abil luua. Lisateave: Koodiga kohandatud API loomine.

Teie ALM-protsessi võib paremini teenindada kohandatud API-de loomine lahendusefailide redigeerimise teel. Lisateave: Lahendusefailidega kohandatud API loomine.

Vaata ka

Kohandatud API-de loomine ja kasutamine
Kohandatud API loomine pistikprogrammi registreerimistööriista abil
Looge koodiga kohandatud API
Lahendusefailidega kohandatud API loomine
Looge oma sõnumeid