Креирајте прилагођени АПИ у Повер Аппс-у

Када креирате прилагођени АПИ, морате користити решење. Ако нисте упознати са решењима, прво прочитајте Креирајте решење .

Ваше решење мора бити повезано са издавачем. Издавач има специфичан префикс прилагођавања повезан са њим. Морате користити префикс прилагођавања приликом креирања прилагођеног АПИ-ја и овај префикс треба да буде исти који користи издавач вашег решења. Следећа упутства користе вредност sample као префикс прилагођавања јер је то један сет за издавача.

Важно

• Сада постоји боље искуство за креирање прилагођеног АПИ-ја. Можете користити дизајнера у оквиру алата за регистрацију плуг-ина. Више информација: Креирајте прилагођени АПИ помоћу алата за регистрацију додатака
• Многа поља која се односе на креирање прилагођеног АПИ-ја не могу се променити након што их креирате. Требало би да пажљиво планирате дизајн прилагођеног АПИ-ја пре него што почнете. Ако касније одлучите да морате да промените ствари након што креирате прилагођени АПИ, можда ћете морати да избришете постојећи запис и поново креирате прилагођени АПИ. Прегледајте информације о колонама које се овде не могу променити: ЦустомАПИ табеле

Креирајте прилагођени АПИ запис

1. У вашем решењу изаберите Нев > Море > Отхер > цустом АПИ из падајућег менија.

2. Измените поља да бисте поставили својства вашег прилагођеног АПИ-ја. Морате подесити вредности за следећа поља. За више информација погледајте Прилагођене колоне АПИ табеле

   Не можете подесити вредности за Тип додатка пре него што креирате додатак. Назив можете променити касније.

3. Изаберите ставку Сачувај. Ваш образац треба да изгледа овако:

Креирајте све параметре захтева

Прилагођени АПИ не захтева параметре. Креирајте онолико параметара колико вам је потребно да прођете податке потребне за вашу логику.

1. У вашем решењу изаберите Нев > Море > Море Отхер > Цустом АПИ Реqуест Параметер из падајућег менија.

2. Измените поља да бисте поставили својства вашег прилагођеног параметра АПИ захтева. За више информација, погледајте ЦустомАПИРекуестПараметер Табле Цолумнс

3. Изаберите ставку Сачувај. Ваш образац би требало да изгледа овако:

   

Креирајте било које особине одговора

Прилагођени АПИ који представља акцију не захтева особине одговора. Функција мора имати најмање једну. Ако операција успе, враћа одговор на успех. Ако не успе, враћа грешку. Требало би да дефинишете својства одговора за све податке које ваш АПИ враћа.

Ако је дефинисана само једна особина одговора ентитета или ЕнтитyЦоллецтион , одговор је тог типа. Ако постоји више особина, или једна или више особина једноставног типа, АПИ враћа комплексни тип где је свака особина одговора особина тог сложеног типа.

На пример, ако је sample_CustomAPIExample ваш прилагођени АПИ јединствено име , враћа сложени тип назван sample_CustomAPIExampleResponse са својствима за сваку особину одговора коју дефинишете.

1. У вашем решењу изаберите Нев > Море > Море Отхер > Цустом АПИ Респонсе Пропертy из падајућег менија.

2. Измените поља да бисте поставили својства вашег прилагођеног АПИ Респонсе Пропертy. За више информација, погледајте ЦустомАПИРеспонсеПропертy Табле Цолумнс

3. Изаберите ставку Сачувај. Ваш образац би требало да изгледа овако:

   

Посматрајте резултат у сервисном документу

Ако нисте подесили својство IsPrivate за ваш прилагођени АПИ, сада можете да преузмете дефиницију услуге из ЦСДЛ $ метадата документа користећи захтев, GET чак и из вашег претраживача. Ако је https://yourorg.crm.dynamics.com УРЛ за ваше окружење , можете да унесете овај УРЛ у поље адресе претраживача да бисте преузели $ метадата: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Претражите резултат да бисте пронашли име прилагођеног АПИ-ја. На пример, АПИ дефинисан помоћу горе наведених корака изгледа овако:

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

Тестирајте свој прилагођени АПИ

Након што креирате прилагођени АПИ, можете га испробати. Чак и ако нисте поставили тип додатка да дефинишете главну операцију, можете га тестирати сада да бисте проверили да ли можете да га позовете исправно. Свака особина одговора враћа своју подразумевану вредност, као што је нулл. Више информација: Позивање на прилагођене АПИ-је .

Ажурирајте прилагођени тип АПИ додатка

За информације о томе како написати додатак за прилагођени АПИ , погледајте Напишите додатак за прилагођени АПИ.

Након што региструјете свој склоп, потребно је да подесите вредност Тип додатка за прилагођени АПИ који сте креирали. Ово је особина претраге, тако да само треба да пронађете Плуг-ин тип који представља тип креиран када региструјете асемблер.

Када подесите тип додатка , можете тестирати свој прилагођени АПИ да бисте проверили да ли су исправни резултати враћени.

Други начини за креирање прилагођених АПИ-ја

Алат за регистрацију додатака обезбеђује прилагођени АПИ дизајнер. Више информација: Креирајте прилагођени АПИ помоћу алата за регистрацију додатака

Можда имате захтеве за креирање клијентске апликације која омогућава креирање прилагођених АПИ-ја изван дизајнера. Пошто се подаци за прилагођене АПИ-је чувају у табелама, можете их креирати помоћу кода. Више информација: Креирајте прилагођени АПИ са кодом .

Ваш АЛМ процес би могао бити боље послужен креирањем прилагођених АПИ-ја уређивањем датотека решења. Више информација: Креирајте прилагођени АПИ са датотекама решења .

Такође погледајте

Креирајте и користите прилагођене АПИ-је
Креирајте прилагођени АПИ помоћу алата за регистрацију плуг-ин
Креирајте прилагођени АПИ са кодом
Креирајте прилагођени АПИ са датотекама решења
Креирајте сопствене поруке