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

Овај чланак објашњава како креирати прилагођени АПИ у < ДИЦТ__Поwер ⚐ Аппс > Поwер Аппс за < ДИЦТ__Мицрософт ⚐ Датаверсе > Мицрософт Датаверсе помоћу решења. Пратите ове кораке да бисте дефинисали својства захтева и одговора, тестирали прилагођени АПИ и повезали његов тип додатка. Ако нисте упознати са решењима, прво прочитајте Креирајте решење .

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

Важно

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

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

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

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

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

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

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

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

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

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

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

   

Креирајте својства одговора

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

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

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

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

2. Уредите поља да бисте поставили својства вашег прилагођеног АПИ одговора. За више информација погледајте ЦустомАПИРеспонсеПроперт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>

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

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

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

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

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

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

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

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

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

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

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

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