Stvaranje prilagođenog API-ja u usluzi Power Apps

U ovom se članku objašnjava kako stvoriti prilagođeni API Power Apps za Microsoft Dataverse pomoću rješenja. Slijedite ove korake da biste definirali svojstva zahtjeva i odgovora, testirajte prilagođeni API i povezali njegovu vrstu programskog priključka. Ako niste upoznati s rješenjima, najprije pročitajte članak Stvaranje rješenja.

Vaše rješenje mora biti povezano s izdavačem. Izdavač ima određeni prefiks prilagodbe povezan s njim. Pri stvaranju prilagođenog API-ja morate koristiti prefiks prilagodbe, a taj prefiks trebao bi biti isti prefiks koji koristi izdavač vašeg rješenja. Sljedeće upute koriste vrijednost sample kao prefiks prilagodbe jer je to onaj koji je postavljen za izdavača.

Važno

  • Sada postoji bolje iskustvo za stvaranje prilagođenog API-ja. Možete koristiti dizajnera unutar alata za registraciju dodataka. Dodatne informacije potražite u članku Stvaranje prilagođenog API-ja pomoću alata za registraciju dodatka.
  • Ne možete promijeniti mnoga polja povezana sa stvaranjem prilagođenog API-ja nakon što ih stvorite. Pažljivo isplanirajte dizajn prilagođenog API-ja prije početka. Ako kasnije odlučite da morate promijeniti ta polja, možda ćete morati izbrisati postojeći zapis i ponovno stvoriti prilagođeni API. Dodatne informacije potražite u tablicama CustomAPI.

Stvaranje prilagođenog API zapisa

  1. U svom rješenju odaberite Novi>Više>Drugi>prilagođeni API s padajućeg izbornika.

  2. Uredite polja da biste postavili svojstva prilagođenog API-ja. Postavite vrijednosti za sljedeća polja. Dodatne informacije potražite u članku Stupci tablice prilagođenog API-ja.

    Ne možete postaviti vrijednosti za Vrsta dodatka prije stvaranja dodatka. Tu vrijednost kasnije možete promijeniti.

  3. Odaberite Spremi. Obrazac bi trebao izgledati slično sljedećoj slici: snimka zaslona spremljenog prilagođenog obrasca API-ja s konfiguriranim svojstvima.

Stvaranje parametara zahtjeva

Prilagođeni API ne zahtijeva parametre. Stvorite onoliko parametara koliko vam je potrebno za prosljeđivanje podataka potrebnih za vašu logiku.

  1. U svom rješenju odaberite> NoviViše>drugih>prilagođenih API zahtjeva s padajućeg izbornika.

  2. Uredite polja da biste postavili svojstva prilagođenog parametra zahtjeva API-ja. Dodatne informacije potražite u članku Stupci tablice CustomAPIRequestParameter.

  3. Odaberite Spremi. Obrazac bi trebao izgledati slično sljedećoj slici:

    Snimka zaslona s primjerom obrasca parametra prilagođenog API-ja.

Stvaranje svojstava odgovora

Prilagođeni API koji predstavlja akciju ne zahtijeva svojstva odgovora. Funkcija mora imati barem jednu. Ako operacija uspije, vraća uspješan odgovor. Ako ne uspije, vraća pogrešku. Definirajte svojstva odgovora za sve podatke koje API vraća.

Ako definirate samo jedno svojstvo odgovora entitetaili EntityCollection , odgovor je te vrste. Ako definirate više svojstava ili jedno ili više svojstava jednostavne vrste, API vraća kompleksnu vrstu u kojoj je svako svojstvo odgovora svojstvo te složene vrste.

Ako je, primjerice, vaš prilagođeni jedinstveni sample_CustomAPIExamplenaziv API-ja , sample_CustomAPIExampleResponse vratit će kompleksnu vrstu s nazivom sa svojstvima za svako svojstvo odgovora koje definirate.

  1. U svom rješenju odaberite Novo>više>Drugo>svojstvo odgovora prilagođenog API-ja na padajućem izborniku.

  2. Uredite polja da biste postavili svojstva prilagođenog svojstva odgovora API-ja. Dodatne informacije potražite u članku Stupci tablice CustomAPIResponseProperty.

  3. Odaberite Spremi. Obrazac bi trebao izgledati slično sljedećoj slici:

    Snimka zaslona obrasca svojstva odgovora prilagođenog API-ja.

Pridržavajte se rezultata u servisnom dokumentu

Ako ne postavite IsPrivate svojstvo za prilagođeni API, definiciju servisa iz CSDL-aGET možete dohvatiti $metadata pomoću zahtjeva, čak i iz preglednika. Ako je URL vašeg okruženja https://yourorg.crm.dynamics.com, taj URL možete upisati u polje adrese preglednika da biste dohvatili url $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Pretražite rezultat da biste pronašli naziv prilagođenog API-ja. PRIMJERICE, API definiran pomoću prethodnih 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>

Testiranje prilagođenog API-ja

Kada stvorite prilagođeni API, možete ga isprobati. Čak i ako ne postavite vrstu dodatka da biste definirali glavnu operaciju, sada je možete testirati da biste provjerili možete li je pravilno nazvati. Sva svojstva odgovora vraćaju svoju zadanu vrijednost, kao što je null. Dodatne informacije potražite u članku Pozivanje prilagođenih API-ja.

Ažuriranje prilagođene vrste dodatka za API

Informacije o tome kako napisati dodatak za prilagođeni API potražite u odjeljku Pisanje dodatka za prilagođeni API.

Nakon što registrirate sklop, morate postaviti vrijednost Vrsta dodatka za prilagođeni API koji ste stvorili. Ta je vrijednost svojstvo pretraživanja, pa samo morate pronaći vrstu dodatka koja predstavlja vrstu stvorenu kada ste registrirali sklop.

Snimka zaslona s vrijednostima koje se koriste za postavljanje prilagođene vrste dodatka ZA API.

Kada postavite vrstu dodatka, možete testirati prilagođeni API da biste provjerili vraćaju li se točni rezultati.

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

Alat za registraciju dodataka pruža prilagođeni API dizajner. Dodatne informacije potražite u članku Stvaranje prilagođenog API-ja pomoću alata za registraciju dodatka.

Možda imate zahtjeve za stvaranje klijentske aplikacije koja omogućuje stvaranje prilagođenih API-ja izvan dizajnera. Budući da se podaci za prilagođene API-je pohranjuju u tablice, možete ih stvoriti pomoću koda. Dodatne informacije potražite u članku Stvaranje prilagođenog API-ja s kodom.

Vaš ALM proces mogao bi biti bolji od stvaranja prilagođenih API-ja uređivanjem datoteka rješenja. Dodatne informacije potražite u članku Stvaranje prilagođenog API-ja s datotekama rješenja.

Vidi također

Stvaranje i korištenje prilagođenih API-ja
Izrada prilagođenog API-ja pomoću alata za registraciju dodatka
Stvaranje prilagođenog API-ja s kodom
Stvaranje prilagođenog API-ja s datotekama rješenja
Izrada vlastitih poruka

  • Last updated on