Power Apps бағдарламасында реттелетін API жасау

Әдеттегі API-ді орнатқанда, сіз шешімді пайдалануыңыз керек. Егер сіз шешімдермен таныс болмасаңыз, алдымен Шешім жасаңыз.

Сіздің өтінішіңіз баспагермен байланыстырылуы керек. Баспагердің онымен байланысты арнайы теңшеу префиксі бар. Реттелетін API жасау кезінде реттеу префиксін пайдалануыңыз керек және бұл префикс сіздің шешіміңіздің баспагері қолданатын сияқты болуы керек. Келесі нұсқауларда мәнді sample реттеу префиксі ретінде пайдаланады, өйткені ол баспагер үшін орнатылған.

Маңызды

• Енді әдеттегі API құру үшін жақсы тәжірибе бар. Сіз Plug-in тіркеу құралында дизайнерді пайдалана аласыз. Қосымша ақпарат: Плагинді тіркеу құралын пайдаланып реттелетін API жасау
• Реттелетін API құруға қатысты көптеген өрістер сіз жасағаннан кейін өзгертілмейді. Бастамас бұрын әдеттегі API-дің дизайнын мұқият жоспарлауыңыз керек. Егер кейінірек реттелетін API-ді жасағаннан кейін заттарды өзгерту қажет деп шешсеңіз, бұрыннан бар жазбаны жою және реттелетін API-ді қайта жасау қажет болуы мүмкін. Өзгертуге болмайтын бағандар туралы ақпаратты мына жерден қарап шығыңыз: CustomAPI кестелері

Реттелетін API жазбасын жасау

1. Шешіміңізде ашылмалы тізімнен Жаңа>>басқа>реттелетін API тармағын таңдаңыз.

2. Реттелетін API қасиеттерін орнату үшін өрістерді өңдеңіз. Келесі өрістер үшін мәндерді орнату керек. Қосымша ақпарат алу үшін Реттелетін API кесте бағандары бөлімін қараңыз

   Плагинді жасамас бұрын Плагин түрі үшін мәндерді орната алмайсыз. Мұны кейінірек өзгерте аласыз.

3. Сақтау опциясын таңдаңыз. Сіздің пішініңіз келесідей болуы керек:

Кез келген сұрау параметрлерін жасау

Әдеттегі API параметрлерін қажет етпейді. Логикаңыз үшін қажетті деректерді беру үшін қажетті параметрлерді жасаңыз.

1. Шешіміңізде ашылмалы тізімненЖаңа>>басқа>реттелетін API сұрау параметрі тармағын таңдаңыз.

2. Реттелетін API сұрау параметрінің сипаттарын орнату үшін өрістерді өңдеңіз. Қосымша ақпарат алу үшін CustomAPIRequestParameter кесте бағандары бөлімін қараңыз

3. Сақтау опциясын таңдаңыз. Сіздің пішініңіз келесідей болуы керек:

   

Кез келген жауап сипаттарын жасау

Әрекетті білдіретін реттелетін API жауап қасиеттерін қажет етпейді. Бір функцияның кем дегенде біреуі болуы керек. Егер операция сәтті орындалса, ол сәтті жауап береді. Егер ол сәтсіздікке ұшыраса, қатені қайтарады. API қайтаратын кез келген деректер үшін жауап сипаттарын анықтауыңыз керек.

Егер тек бір Entity немесе EntityCollection жауап сипаты анықталған болса, жауап сол типтегі болады. Егер бірнеше қасиеттер немесе қарапайым типтегі бір немесе бірнеше қасиеттер болса, API әр жауап сипаты сол күрделі типтің сипаты болып табылатын күрделі типті қайтарады.

Мысалы, егер реттелетін API бірегей атауы sample_CustomAPIExample, ол анықталған әрбір жауап сипаты үшін сипаттарымен аталатын sample_CustomAPIExampleResponse күрделі типті қайтарады.

1. Шешіміңізде ашылмалы тізімненЖаңа>>басқа>реттелетін API жауабы сипаты тармағын таңдаңыз.

2. Реттелетін API жауап сипатының сипаттарын орнату үшін өрістерді өңдеңіз. Қосымша ақпарат алу үшін CustomAPIResponseProperty кесте бағандары бөлімін қараңыз

3. Сақтау опциясын таңдаңыз. Сіздің пішініңіз келесідей болуы керек:

   

Қызмет көрсету құжатында нәтижені бақылау

Егер реттелетін API үшін сипатты орнатпаған IsPrivate болсаңыз, енді қызмет анықтамасын CSDL $metadata құжатынан сұрау арқылы, GET тіпті браузерден де ала аласыз. Егер ортаңыздың https://yourorg.crm.dynamics.comURL мекенжайы болса, $metadata алу үшін шолғыштың мекенжай өрісіне осы URL мекенжайын теруге болады: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Әдеттегі API атауын табу үшін нәтижені іздеңіз. Мысалы, жоғарыда көрсетілген қадамдарды қолдана отырып анықталған API келесідей көрінеді:

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

Реттелетін API файлын тексеру

Әдеттегі API-ді орнатқаннан кейін, оны сынап көруге болады. Негізгі операцияны анықтау үшін плагин түрін орнатпаған болсаңыз да, оны дұрыс шақыруға болатындығын тексеру үшін оны қазір сынап көруге болады. Кез келген жауап сипаты әдепкі мәнін қайтарады, мысалы, null. Қосымша ақпарат: Реттелетін API-лерді шақыру.

Реттелетін API плагин модулінің түрін жаңарту

Реттелетін API үшін плагинді жазу әдісі туралы ақпарат алу үшін Реттелетін API үшін плагин жазу бөлімін қараңыз.

Жиынтықты тіркегеннен кейін, сіз жасаған реттелетін API үшін Плагин түрі мәнін орнатуыңыз керек. Бұл іздеу сипаты, сондықтан сіз тек құрасты тіркеген кезде жасалған типті білдіретін плагин түрін табуыңыз керек.

Плагин түрін орнатқаннан кейін, дұрыс нәтижелердің қайтарылғанын тексеру үшін реттелетін API-ді тексеруге болады.

Реттелетін API-лерді құрудың басқа жолдары

Плагинді тіркеу құралы реттелетін API дизайнерін ұсынады. Қосымша ақпарат: Плагинді тіркеу құралын пайдаланып реттелетін API жасау

Сізде дизайнерден тыс реттелетін API жасауға мүмкіндік беретін клиенттік қосымшаны жасау талаптары болуы мүмкін. Реттелетін API деректері кестелерде сақталғандықтан, оларды код арқылы жасауға болады. Қосымша ақпарат: Кодпен реттелетін API жасаңыз.

Сіздің ALM процесіңіз шешім файлдарын өңдеу арқылы реттелетін API жасау арқылы жақсы қызмет етуі мүмкін. Қосымша ақпарат: Шешім файлдарымен реттелетін API жасаңыз.

Келесіні де қараңыз:

Пайдаланушы API интерфейстерін жасаңыз және пайдаланыңыз
Плагинді тіркеу құралын пайдаланып реттелетін API жасау
Кодпен реттелетін API жасау
Шешім файлдары бар реттелетін API жасау
Өз хабарларыңызды жасау