Pasirinktinės API kūrimas "Power Apps"

Kurdami pasirinktinę API, turite naudoti sprendimą. Jei nesate susipažinę su sprendimais, pirmiausia perskaitykite Sprendimo kūrimas.

Jūsų sprendimas turi būti susietas su leidėju. Leidėjas turi su juo susietą konkretų tinkinimo priešdėlį. Kurdami pasirinktinę API turite naudoti tinkinimo priešdėlį, kuris turi būti toks pat, kokį naudoja jūsų sprendimo leidėjas. Toliau pateiktose instrukcijose reikšmė sample naudojama kaip tinkinimo priešdėlis, nes ji nustatyta leidėjui.

Svarbu

• Dabar yra geresnė pasirinktinės API kūrimo patirtis. Galite naudoti dizaino įrankį papildinio registracijos įrankyje. Daugiau informacijos: Pasirinktinės API kūrimas naudojant priedo registracijos įrankį
• Daugelio laukų, susijusių su pasirinktinės API kūrimu, negalima keisti juos sukūrus. Prieš pradėdami turėtumėte atidžiai suplanuoti pasirinktinės API dizainą. Jei vėliau nuspręsite, kad sukūrę pasirinktinę API turite ką nors pakeisti, gali tekti panaikinti esamą įrašą ir iš naujo sukurti pasirinktinę API. Peržiūrėkite informaciją apie stulpelius, kurių negalima keisti čia: CustomAPI lentelės

Tinkinto API įrašo kūrimas

1. Sprendime išplečiamajame meniu pasirinkite Nauja>daugiau>Kita>tinkinta API .

2. Redaguokite laukus, kad nustatytumėte pasirinktinės API ypatybes. Turite nustatyti šių laukų reikšmes. Daugiau informacijos rasite Tinkintų API lentelės stulpeliai

   Prieš kurdami priedą negalite nustatyti priedo tipo reikšmių. Vėliau galėsite tai pakeisti.

3. Pasirinkite Įrašyti. Forma turėtų atrodyti maždaug taip:

Sukurkite bet kokius užklausos parametrus

Tinkintai API nereikia parametrų. Sukurkite tiek parametrų, kiek reikia jūsų logikai reikalingiems duomenims perduoti.

1. Sprendime išskleidžiamajame meniu pasirinkite Naujas>kitas>>tinkintas API užklausos parametras.

2. Redaguokite laukus, kad nustatytumėte pasirinktinio API užklausos parametro ypatybes. Daugiau informacijos rasite CustomAPIRequestParameter lentelės stulpeliai

3. Pasirinkite Įrašyti. Jūsų forma turėtų atrodyti maždaug taip:

   

Kurti bet kokias atsakymo ypatybes

Pasirinktinei API, kuri nurodo veiksmą, atsakymo ypatybių nereikia. Funkcija turi turėti bent vieną. Jei operacija pavyksta, ji pateikia sėkmingą atsakymą. Jei nepavyksta, pateikiama klaida. Turėtumėte apibrėžti atsakymo ypatybes bet kokiems duomenims, kuriuos pateikia jūsų API.

Jei apibrėžta tik viena Entity arba EntityCollection atsakymo ypatybė, atsakymas yra tokio tipo. Jei yra kelios ypatybės arba viena ar daugiau paprasto tipo ypatybių, API grąžina sudėtingą tipą, kuriame kiekviena atsakymo ypatybė yra to sudėtingo tipo ypatybė.

Pavyzdžiui, jei jūsų pasirinktinis API unikalus pavadinimas yra sample_CustomAPIExample, jis pateikia sudėtingą tipą, pavadintą sample_CustomAPIExampleResponse su kiekvienos apibrėžtos atsakymo ypatybės ypatybėmis.

1. Sprendime išplečiamajame meniu pasirinkite Nauja>kita>>tinkinta API atsakymo ypatybė.

2. Redaguokite laukus, kad nustatytumėte pasirinktinės API atsakymo ypatybės ypatybes. Daugiau informacijos rasite CustomAPIResponseProperty lentelės stulpeliai

3. Pasirinkite Įrašyti. Jūsų forma turėtų atrodyti maždaug taip:

   

Atkreipkite dėmesį į rezultatą techninės priežiūros dokumente

Jei nenustatėte IsPrivate pasirinktinės API ypatybės, dabar galite gauti paslaugos aprašą iš CSDL $metadata dokumento naudodami užklausą GET , net iš naršyklės. Jei jūsų aplinkos URL yra https://yourorg.crm.dynamics.com, galite įvesti šį URL naršyklės adreso lauke, kad gautumėte $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Ieškokite rezultato, kad rastumėte pasirinktinės API pavadinimą. Pavyzdžiui, API, apibrėžta atliekant aukščiau nurodytus veiksmus, atrodo taip:

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

Išbandykite pasirinktinę API

Sukūrę pasirinktinę API, galite ją išbandyti. Net jei nenustatėte priedo tipo, kad nustatytumėte pagrindinę operaciją, galite jį išbandyti dabar, kad patikrintumėte, ar galite tinkamai jį iškviesti. Bet kokios atsakymo ypatybės grąžina numatytąją reikšmę, pvz., nulinę. Daugiau informacijos: Pasirinktinių API iškvietimas.

Tinkinto API papildinio tipo atnaujinimas

Informacijos apie tai, kaip parašyti pasirinktinės API priedą, ieškokite Pasirinktinės API priedo rašymas.

Užregistravę agregatą, turite nustatyti sukurtos pasirinktinės API įskiepio tipo reikšmę. Tai yra peržvalgos ypatybė, todėl jums tereikia rasti priedo tipą, kuris nurodo tipą, sukurtą registruojant rinkinį.

Nustatę papildinio tipą, galite išbandyti pasirinktinę API, kad patikrintumėte, ar pateikiami teisingi rezultatai.

Kiti pasirinktinių API kūrimo būdai

Įskiepio registracijos įrankis suteikia pasirinktinį API dizainerį. Daugiau informacijos: Pasirinktinės API kūrimas naudojant priedo registracijos įrankį

Gali kilti reikalavimų sukurti kliento programą, leidžiančią kurti pasirinktines API už dizaino įrankio ribų. Kadangi pasirinktinių API duomenys saugomi lentelėse, galite juos kurti naudodami kodą. Daugiau informacijos: Tinkintos API su kodu kūrimas.

Jūsų ALM procesas gali būti naudingesnis kuriant pasirinktines API redaguojant sprendimo failus. Daugiau informacijos: Pasirinktinės API su sprendimų failais kūrimas.

Taip pat žr.

Pasirinktinių API kūrimas ir naudojimas
Sukurkite pasirinktinę API naudodami įskiepio registracijos įrankį
Sukurkite pasirinktinę API su kodu
Pasirinktinės API su sprendimo failais kūrimas
Sukurkite savo pranešimus