Kreirajte prilagođeni API u Pover Apps-u

Kada kreirate prilagođeni API, morate koristiti rešenje. Ako niste upoznati sa rešenjima, prvo pročitajte Kreirajte rešenje.

Vaše rešenje mora biti povezano sa izdavačem. Izdavač ima specifičan prefiks prilagođavanja povezan sa njim. Morate koristiti prefiks prilagođavanja prilikom kreiranja prilagođenog API-ja i ovaj prefiks treba da bude isti koji koristi izdavač vašeg rešenja. Sledeća uputstva koriste vrednost sample kao prefiks prilagođavanja jer je to jedan set za izdavača.

Važno

• Sada postoji bolje iskustvo za kreiranje prilagođenog API-ja. Možete koristiti dizajnera u okviru alata za registraciju plug-ina. Više informacija: Kreirajte prilagođeni API pomoću alata za registraciju dodataka
• Mnoga polja koja se odnose na kreiranje prilagođenog API-ja ne mogu se promeniti nakon što ih kreirate. Trebalo bi da pažljivo planirate dizajn prilagođenog API-ja pre nego što počnete. Ako kasnije odlučite da morate da promenite stvari nakon što kreirate prilagođeni API, možda ćete morati da izbrišete postojeći zapis i ponovo kreirate prilagođeni API. Pregledajte informacije o kolonama koje se ovde ne mogu promeniti: CustomAPI tabele

Kreirajte prilagođeni API zapis

1. U vašem rešenju izaberite Nev>More>Other>custom API iz padajućeg menija.

2. Izmenite polja da biste postavili svojstva vašeg prilagođenog API-ja. Morate podesiti vrednosti za sledeća polja. Za više informacija pogledajte Prilagođene kolone API tabele

   Ne možete podesiti vrednosti za Tip dodatka pre nego što kreirate dodatak. Naziv možete promeniti kasnije.

3. Izaberite stavku Sačuvaj. Vaš obrazac treba da izgleda ovako:

Kreirajte sve parametre zahteva

Prilagođeni API ne zahteva parametre. Kreirajte onoliko parametara koliko vam je potrebno da prođete podatke potrebne za vašu logiku.

1. U vašem rešenju izaberite Nev>More>More Other>Custom API Request Parameter iz padajućeg menija.

2. Izmenite polja da biste postavili svojstva vašeg prilagođenog parametra API zahteva. Za više informacija, pogledajte CustomAPIRekuestParameter Table Columns

3. Izaberite stavku Sačuvaj. Vaš obrazac bi trebalo da izgleda ovako:

   

Kreirajte bilo koje osobine odgovora

Prilagođeni API koji predstavlja akciju ne zahteva osobine odgovora. Funkcija mora imati najmanje jednu. Ako operacija uspe, vraća odgovor na uspeh. Ako ne uspe, vraća grešku. Trebalo bi da definišete svojstva odgovora za sve podatke koje vaš API vraća.

Ako je definisana samo jedna osobina odgovora entiteta ili EntityCollection , odgovor je tog tipa. Ako postoji više osobina, ili jedna ili više osobina jednostavnog tipa, API vraća kompleksni tip gde je svaka osobina odgovora osobina tog složenog tipa.

Na primer, ako je sample_CustomAPIExamplevaš prilagođeni API jedinstveno ime , vraća složeni tip nazvan sample_CustomAPIExampleResponse sa svojstvima za svaku osobinu odgovora koju definišete.

1. U vašem rešenju izaberite Nev>More>More Other>Custom API Response Property iz padajućeg menija.

2. Izmenite polja da biste postavili svojstva vašeg prilagođenog API Response Property. Za više informacija, pogledajte CustomAPIResponseProperty Table Columns

3. Izaberite stavku Sačuvaj. Vaš obrazac bi trebalo da izgleda ovako:

   

Posmatrajte rezultat u servisnom dokumentu

Ako niste podesili svojstvo IsPrivate za vaš prilagođeni API, sada možete da preuzmete definiciju usluge iz CSDL $metadata dokumenta koristeći zahtev, GET čak i iz vašeg pretraživača. Ako je https://yourorg.crm.dynamics.comURL za vaše okruženje , možete da unesete ovaj URL u polje adrese pretraživača da biste preuzeli $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Pretražite rezultat da biste pronašli ime prilagođenog API-ja. Na primer, API definisan pomoću gore navedenih koraka izgleda ovako:

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

Testirajte svoj prilagođeni API

Nakon što kreirate prilagođeni API, možete ga isprobati. Čak i ako niste postavili tip dodatka da definišete glavnu operaciju, možete ga testirati sada da biste proverili da li možete da ga pozovete ispravno. Svaka osobina odgovora vraća svoju podrazumevanu vrednost, kao što je null. Više informacija: Pozivanje na prilagođene API-je.

Ažurirajte prilagođeni tip API dodatka

Za informacije o tome kako napisati dodatak za prilagođeni API, pogledajte Napišite dodatak za prilagođeni API.

Nakon što registrujete svoj sklop, potrebno je da podesite vrednost Tip dodatka za prilagođeni API koji ste kreirali. Ovo je osobina pretrage, tako da samo treba da pronađete Plug-in tip koji predstavlja tip kreiran kada registrujete asembler.

Kada podesite tip dodatka, možete testirati svoj prilagođeni API da biste proverili da li su ispravni rezultati vraćeni.

Drugi načini za kreiranje prilagođenih API-ja

Alat za registraciju dodataka obezbeđuje prilagođeni API dizajner. Više informacija: Kreirajte prilagođeni API pomoću alata za registraciju dodataka

Možda imate zahteve za kreiranje klijentske aplikacije koja omogućava kreiranje prilagođenih API-ja izvan dizajnera. Pošto se podaci za prilagođene API-je čuvaju u tabelama, možete ih kreirati pomoću koda. Više informacija: Kreirajte prilagođeni API sa kodom.

Vaš ALM proces bi mogao biti bolje poslužen kreiranjem prilagođenih API-ja uređivanjem datoteka rešenja. Više informacija: Kreirajte prilagođeni API sa datotekama rešenja.

Takođe pogledajte

Kreirajte i koristite prilagođene API-je
Kreirajte prilagođeni API pomoću alata za registraciju plug-in
Kreirajte prilagođeni API sa kodom
Kreirajte prilagođeni API sa datotekama rešenja
Kreirajte sopstvene poruke