Общ преглед на уеб API на портали
Уеб API на порталите дава възможност за по-богато потребителско изживяване в сайтовете на Power Pages. Можете да използвате уеб API за извършване на операции по създаване, четене, актуализиране и изтриване във всички таблици на Microsoft Dataverse от вашите уеб страници. Например можете да създадете нов акаунт, да актуализирате контакт, без да използвате формуляр или многостъпков формуляр с помощта на уеб API на порталите.
Важно
- Версията на сайта Ви Power Pages трябва да е 9.3.3.x или по-нова, за да работи тази функция.
- Уеб API на порталите е създаден за създаване на богато потребителско изживяване в страници на портали. Той не е оптимизиран за услуги или интеграция на приложения на трети страни. Използването на уеб API на порталите за интегриране с други сайтове на Power Pages също не се поддържа.
- Операциите на уеб API на портали са ограничени до таблици, свързани с данни, например акаунти, контакти или персонализирани таблици. Конфигуриране на метаданни на таблица или данни за конфигурационна таблица на портал, например конфигуриране на таблици на портали, като adx_contentsnippet, adx_entityform или adx_entitylist, не се поддържа с уеб API на портали. За пълен списък отидете на неподдържани конфигурационни таблици по-нататък в тази статия.
- Порталите Web API се възползват от кеширане от страна на сървъра и следователно следващите повиквания към уеб API са по-бързи от първоначалните. Изчистването на кеша от страна на сървъра на портала причинява временно влошаване на производителността.
- Операциите на Уеб API на портали изискват лиценз на Power Pages. Например извикванията на уеб API, направени от анонимни потребители, се отчитат в капацитета за анонимни потребители. Извикванията на уеб API, направени от удостоверени потребители (вътрешни или външни), не се отчитат към показванията на страници, но изискват приложими лицензи за удостоверен потребителски капацитет. Допълнителна информация: ЧЗВ за лицензиране на Power Pages
Операции с уеб API
Уеб API на порталите предлага подмножество от възможности за Dataverse операции, които можете да направите, като използвате Dataverse API. Запазихме формата на API възможно най-подобен, за да намалим кривата на обучение.
Бележка
Операциите на уеб API са чувствителни към малки и големи букви.
Операции на уеб API, достъпни Power Pages
- Четене на записи от таблица
- Създаване на запис в таблица
- Актуализиране и изтриване на записи в таблица
- Асоцииране и изключване на таблици
Бележка
Извикването на действия и функции с помощта на уеб API на порталите не се поддържа.
Настройки на сайта за Уеб API
Трябва да активирате настройката на сайта, за да активирате уеб API на порталите за вашия портал. Можете също така да конфигурирате Web API на ниво поле, което определя полетата на таблицата, които могат или не могат да бъдат модифицирани с Web API на порталите.
Бележка
Използвайте логическо име на таблицата за тези настройки (напр. акаунт).
Име на настройка на сайт | Описание |
---|---|
Webapi/<име> на таблица/активирано | Активира или дезактивира уеб API за <име на таблица>. По подразбиране: False Валидни стойности: True , False |
Webapi/<име> на таблица/полета | Определя списък с атрибути, разделени със запетая, които могат да бъдат модифицирани с уеб API. Възможни стойности: - Всички атрибути: * - Специфични атрибути: attr1,attr2,attr3 Забележка: Стойността трябва да бъде или звездичка (*), или списък с имена на полета, разделен със запетая. Важно: Тази настройка е задължителна настройка на сайта. Когато тази настройка липсва, виждате грешката "Няма полета, дефинирани за този обект". |
Webapi/грешка/вътрешна грешка | Активира или дезактивира InnerError. По подразбиране: False Валидни стойности: True , False |
Webapi/<име> на таблица/disableodatafilter | Активира или дезактивира филтъра на OData. По подразбиране: False Валидни стойности: True , False Вижте известни проблеми за повече информация. Настройката на сайта е достъпна в портална версия 9.4.10.74 или по-късно. |
Бележка
Настройките на сайта трябва да бъдат зададени на Активни, за да влязат в сила промените.
Например, за да покажете уеб API за таблицата на случай, където удостоверените потребители имат право да извършват операции по създаване, актуализиране и изтриване на този обект, настройките на сайта са показани в следващата таблица.
Име на настройка на сайт | Стойност на настройка на сайт |
---|---|
Webapi/инцидент/активиран | true |
Webapi/инцидент/полета | attr1, attr2, attr3 |
Сигурност с уеб API на порталите
Можете да конфигурирате защитата, базирана на записи, на отделни записи в портали, като използвате разрешения за таблици. Уеб API на портали осъществява достъп до записи на таблици (обект) и следва разрешенията за таблици, дадени на потребителите чрез свързаната уеб роля.
Можете да конфигурирате разрешения за колони за допълнително дефиниране на привилегии за отделни колони в рамките на таблица, докато използвате уеб API на порталите.
Заявки за уеб API за удостоверяване на портали
Не е необходимо да включвате код за удостоверяване, тъй като сесията на приложението управлява удостоверяването и упълномощаването. Всички извиквания на уеб API трябва да включват маркер за фалшифициране на заявки между сайтове (CSRF).
Използване на EntitySetName
Когато се позовавате на Dataverse таблици, използващи уеб API на портали във вашия код, трябва да използвате EntitySetName, например за достъп до таблицата на акаунта , синтаксисът на кода използва EntitySetName на акаунтите; /_api/accounts()
.
Бележка
Използвайте логическото име на таблицата за настройките на сайта (например акаунт).
Можете да определите EntitySetName на конкретни таблици, като следвате тези стъпки:
Преминаване към https://make.powerapps.com
Изберете раздела Dataverse от страничния панел и изберете таблицата.
Изберете ... (Опция за команди) и след това изберете Разширено, Инструменти и Копирайте името на комплекта да копирате EntitySetName от таблицата към вашия клипборд.
Закони и разпоредби за поверителност
Всички заглавки на заявки използват ИД на контакт, предаден за целите на одита. За анонимен потребител тази стойност се предава като null
.
Ако регистрирането на одит е активирано, потребителят може да види всички събития на одита в дневник на одита на Office 365.
Допълнителна информация:
Разрешаване и използване на регистриране на дейности
Експортиране, конфигуриране и преглед на записи от регистрационни файлове за проверка
Неподдържани таблици за конфигуриране
Уеб API на портали не може да се използва за следните конфигурационни таблици:
adx_contentaccesslevel
adx_contentsnippet
adx_entityform
adx_entityformmetadata
adx_entitylist
adx_entitypermission
adx_entitypermission_webrole
adx_externalidentity
adx_pagealert
adx_pagenotification
adx_pagetag
adx_pagetag_webpage
adx_pagetemplate
adx_portallanguage
adx_publishingstate
adx_publishingstatetransitionrule
adx_publishingstatetransitionrule_webrole
adx_redirect
adx_setting
adx_shortcut
adx_sitemarker
adx_sitesetting
adx_urlhistory
adx_webfile
adx_webfilelog
adx_webform
adx_webformmetadata
adx_webformsession
adx_webformstep
adx_weblink
adx_weblinkset
adx_webnotificationentity
adx_webnotificationurl
adx_webpage
adx_webpage_tag
adx_webpageaccesscontrolrule
adx_webpageaccesscontrolrule_webrole
adx_webpagehistory
adx_webpagelog
adx_webrole_systemuser
adx_website
adx_website_list
adx_website_sponsor
adx_websiteaccess
adx_websiteaccess_webrole
adx_websitebinding
adx_websitelanguage
adx_webtemplate
Познати проблеми
Потребителите получават CDS грешка, ако извикат GET
заявка за уеб API за таблици, които имат множество нива от 1 до много или много към многоразрешения за таблици, когато обхватите на родителите, ** контактите или акаунта добавят повече условия към заявката.
За да разрешите този проблем, препоръчителното решение е да използвате FetchXML в заявката OData.
Като алтернатива задайте настройката на сайта Уеб API/<име на таблица>/дезактивиране на филтър на odata на True
.
Важно
Промяната на настройката на сайта Webapi/<table name>/disableodatafilter на True
може да доведе до по-бавна производителност за извиквания на уеб API GET
.
Настройката на сайта е достъпна в портална версия 9.4.10.74 или по-късно.
Следваща стъпка
Заявка за данни с помощта на портали Web API