Створення власного API в Power Apps

У цій статті пояснюється, як створити настроюваний API у Power Apps для Microsoft Dataverse за допомогою рішення. Виконайте наведені нижче дії, щоб визначити властивості запиту та відповіді, перевірити настроюваний API та пов'язати його тип компонента plug-in. Якщо ви не знайомі з рішеннями, спочатку прочитайте статтю Створення рішення.

Ваше рішення має бути пов'язане з видавцем. Видавець має специфічний префікс кастомізації, пов'язаний з ним. Під час створення настроюваного API потрібно використовувати префікс настроювання, і цей префікс має бути тим самим префіксом, який використовується видавцем рішення. У наведених нижче інструкціях це значення sample використовується як префікс настроювання, оскільки воно встановлено для видавця.

Важливо

• Тепер є кращий досвід для створення користувацького API. Ви можете використовувати конструктор в інструменті реєстрації плагінів. Докладні відомості див. в статті Створення настроюваного інтерфейсу API за допомогою засобу реєстрації компонента plug-in.
• Після створення не можна змінити багато полів, пов'язаних зі створенням настроюваного інтерфейсу 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 не настроєно, ви можете отримати визначення служби з документа $metadata CSDL , використовуючи 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, ви можете спробувати його. Навіть якщо ви не встановили тип компонента plug-in для визначення основної операції, ви можете перевірити його зараз, щоб переконатися, що ви можете викликати його правильно. Будь-які властивості відповіді повертають їх значення за замовчуванням, наприклад null. Докладні відомості див. в статті Виклик настроюваних інтерфейсів API.

Оновлення настроюваного типу компонента plug-in API

Для отримання інформації про те, як написати плагін для користувацького API, перегляньте статтю Написання плагіна для вашого користувацького API.

Після того, як ви зареєструєте свою збірку, вам потрібно встановити значення Plugin Type для створеного вами користувацького API. Це значення є властивістю підстановки, тому потрібно просто знайти тип компонента plug-in, який відповідає типу, створеному під час реєстрації складання.

Вибравши тип компонента plug-in, ви можете перевірити свій настроюваний інтерфейс API, щоб перевірити, чи повертаються правильні результати.

Інші способи створення користувацьких API

Інструмент реєстрації плагінів надає спеціальний конструктор API. Докладні відомості див. в статті Створення настроюваного інтерфейсу API за допомогою засобу реєстрації компонента plug-in.

У вас можуть виникнути вимоги щодо створення клієнтської програми, яка дозволяє створювати власні API за межами дизайнера. Оскільки дані для настроюваних інтерфейсів API зберігаються в таблицях, їх можна створити за допомогою коду. Докладні відомості див. в статті Створення настроюваного інтерфейсу API з кодом.

Ваш процес ALM може бути кращим для створення власних API шляхом редагування файлів рішень. Докладні відомості див. в статті Створення настроюваного інтерфейсу API із файлами рішень.

Дивись також

Створюйте та використовуйте власні API
Створіть власний API за допомогою інструменту реєстрації плагінів
Створіть кастомний API з кодом
Створення кастомного API з файлами рішень
Створюйте власні повідомлення