Обзор веб-API порталов
Примечание
Действует с 12 октября 2022 г, в качестве порталов для Power Apps используется Power Pages. Дополнительная информация: Microsoft Power Pages теперь доступен для всех (блог)
Скоро мы мигрируем и объединим документацию порталов Power Apps с документацией Power Pages.
Веб-API порталов обеспечивает более богатый пользовательский интерфейс внутри страниц портала Power Apps. Можно использовать веб-API для выполнения операций создания, чтения, обновления и удаления во всех таблицах Microsoft Dataverse со страниц ваших порталов. Например, вы можете создать новую учетную запись, обновить контакт или изменить разрешения таблицы для продукта с помощью веб-API порталов вместо приложения управления порталами.
Примечание
Можно также использовать веб-API порталов в Power Pages. Дополнительные сведения: Что такое Power Pages
Важно!
- Для работы этой функции вы должны использовать версию портала 9.3.3.x или более позднюю.
- Веб-API порталов улучшает взаимодействие с пользователем внутри страниц порталов. Он не оптимизирован для сторонних сервисов или интеграции приложений. Использование веб-API порталов для интеграции с другими сайтами порталов Power Apps также не поддерживается.
- Операции веб-API порталов ограничены таблицами, связанными с данными, — например, учетные записи, контакты или ваши настраиваемые таблицы. Настройка метаданных таблицы или данных таблицы конфигурации портала — например, настройка таблиц порталов, таких как adx_contentsnippet, adx_entityform или adx_entitylist, — не поддерживается веб-API порталов. Полный список см. в разделе Неподдерживаемые таблицы конфигурации далее в этой теме.
- Веб-API порталов использует преимущества кэширования на стороне сервера, поэтому последующие вызовы веб-API выполняются быстрее, чем первоначальные вызовы. Обратите внимание, что очистка кэша на стороне сервера портала приводит к временному снижению производительности.
- Для работы веб-API порталов требуется лицензия на порталы Power Apps. Например, вызовы веб-API, сделанные анонимными пользователями, учитываются при подсчете количества просмотров страницы. Вызовы веб-API, сделанные аутентифицированными пользователями (внутренними или внешними), не учитываются при просмотре страниц, но требуют соответствующих лицензий. Дополнительные сведения: Вопросы и ответы по лицензированию порталов Power Apps
Операции веб-API
Веб-API порталов предлагает набор возможностей для операций Dataverse, которые можно выполнять с помощью Dataverse API. Мы сохранили формат API как можно более похожим, чтобы сократить время обучения.
Примечание
Операции веб-API зависят от регистра.
Операции веб-API доступны на порталах
- Чтение записей из таблицы
- Создание записи в таблице
- Обновление и удаление записей в таблице
- Связывание и отмена связывания таблиц
Настройки сайта для веб-API
Вы должны включить настройку сайта, чтобы включить веб-API порталов для вашего портала. Вы также можете настроить веб-API на уровне полей, который определяет поля таблицы, которые можно или нельзя изменять с помощью веб-API порталов.
Примечание
Используйте логическое имя таблицы для этих настроек (например account).
| Имя настройки сайта | Description |
|---|---|
| Webapi/<table name>/enabled | Включает или отключает веб-API для <table name>. По умолчанию: False Допустимые значения: True, False |
| Webapi/<table name>/fields | Определяет список атрибутов, разделенных запятыми, которые можно изменить с помощью веб-API. Возможные значения: - Все атрибуты: * - Конкретные атрибуты: attr1,attr2,attr3 Примечание: значение должно быть либо звездочкой (*), либо списком имен полей, разделенных запятыми. Важно. Это обязательная настройка сайта. Если этот параметр отсутствует, вы увидите ошибку «Для этой сущности не определены поля». |
| Webapi/error/innererror | Включает или отключает InnerError. По умолчанию: False Допустимые значения: True, False |
| Webapi/<table name>/disableodatafilter | Включает или отключает фильтр OData. По умолчанию: False Допустимые значения True, False, дополнительные сведениям см. в известных проблемах. Параметр сайта доступен в версии порталов 9.4.10.74 или более новой. |
Примечание
Настройки сайта должны быть установлены на Активно, чтобы изменения вступили в силу.
Например, чтобы предоставить веб-API для таблицы обращений, где аутентифицированным пользователям разрешено выполнять операции создания, обновления и удаления с этой сущностью, параметры сайта показаны в следующей таблице.
| Имя настройки сайта | Значение параметра сайта |
|---|---|
| Webapi/incident/enabled | true |
| Webapi/incident/fields | attr1, attr2, attr3 |
Безопасность с помощью веб-API порталов
Вы можете настроить безопасность на основе записей для отдельных записей на порталах, используя разрешения таблицы. Веб-API порталов обращается к записям таблиц (сущностей) и следует разрешениям таблиц, предоставленным пользователям через связанную веб-роль.
Вы можете настроить разрешения столбца для дальнейшего определения привилегий для отдельных столбцов в таблице при использовании веб-API порталов.
Аутентификация запросов веб-API порталов
Вам не нужно включать код аутентификации, потому что аутентификация и авторизация управляются сеансом приложения. Все вызовы веб-API должны включать токен подделки межсайтовых запросов (CSRF).
Использование Using EntitySetName
Когда речь идет о таблицах Dataverse, использующих веб-API порталов в вашем коде, вам необходимо использовать EntitySetName, например, для доступа к таблице account, синтаксис кода будет использовать EntitySetName из accounts; /_api/accounts().
Примечание
Используйте логическое имя таблицы для настроек сайта (например, account).
Вы можете определить EntitySetName конкретных таблиц, выполнив следующие действия:
Перейдите к https://make.powerapps.com
Выберите Dataverse на боковой панели и выберите таблицу.
Выберите ... (параметр команд), затем выберите Дополнительно, Сервис и Копировать имя набора, чтобы скопировать EntitySetName таблицы в буфер обмена.
Общий регламент по защите данных (GDPR)
Все заголовки запросов будут иметь идентификатор контакта, переданный для целей аудита. Для анонимного пользователя это будет передано как 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, если вызовут запрос веб- API GET для таблиц с несколькими уровнями разрешений в отношении таблиц 1-ко-многим или многие-к-многим с заданной областью parent.
Для устранения этой проблемы рекомендуется использовать FetchXML в запросе OData.
Другой вариант — установить параметр сайта Webapi/<table name>/disableodatafilter в значение True.
Важно!
Изменение значения параметра сайта Webapi/<table name>/disableodatafilter на True может привести к снижению быстродействия вызовов веб-API GET.
Параметр сайта доступен в версии порталов 9.4.10.74 или более новой.
Следующий шаг
Запрос данных с помощью веб-API порталов
См. также
Создание HTTP-запросов и обработка ошибок Порталы записывают, обновляют и удаляют операции с помощью веб-API. Учебник. Использование веб-API порталов
Примечание
Каковы ваши предпочтения в отношении языка документации? Пройдите краткий опрос (обратите внимание, что этот опрос представлен на английском языке).
Опрос займет около семи минут. Личные данные не собираются (заявление о конфиденциальности).
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по