Създаване на персонализиран API в Power Apps

Когато създавате персонализиран API, трябва да използвате решение. Ако не сте запознати с решенията, първо прочетете Създаване на решение.

Вашето решение трябва да е свързано с издател. Издателят има специфичен префикс за персонализиране, свързан с него. Трябва да използвате префикс за персонализиране, когато създавате персонализиран API и този префикс трябва да е същият, използван от издателя на вашето решение. В инструкциите по-долу стойността sample се използва като префикс за персонализиране, тъй като тя е тази, която е зададена за издателя.

Важен

• Вече има по-добро изживяване за създаване на персонализиран API. Можете да използвате дизайнер в инструмента за регистрация на добавки. Повече информация: Създаване на персонализиран 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. Изберете Запиши. Вашата форма трябва да изглежда така:

   

Наблюдавайте резултата в сервизния документ

Ако не сте задали свойството IsPrivate за персонализирания си API, вече можете да извлечете дефиницията на услугата от документа на CSDL $metadata с помощта на GET заявка дори от браузъра си. Ако URL адресът за вашата среда е https://yourorg.crm.dynamics.com, можете да въведете този URL адрес в полето за адрес на браузъра си, за да извлечете $metadata: 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 с файлове с решения
Създайте свои собствени съобщения