Веб-API порталов (предварительная версия)

[Данная статья является предварительной документацией и может быть изменена.]

Обзор

Веб-API порталов позволяет улучшить взаимодействие с пользователем внутри страниц порталов Power Apps. Вы можете использовать веб-API для выполнения операций создания, обновления и удаления во всех сущностях Microsoft Dataverse со страниц вашего портала. Например, вы можете создать новую учетную запись, обновить контакт или изменить разрешения сущности для продукта с помощью веб-API порталов вместо приложения управления порталом.

Важно!

  • Ваша версия портала должна быть 9.2.6.41 или новее, чтобы эта функция работала.
  • Веб-API порталов улучшает взаимодействие с пользователем внутри страниц порталов. Он не оптимизирован для сторонних сервисов или интеграции приложений.
  • Операции веб-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 порталов.

Имя настройки сайта Описание:
Webapi/<entity name>/enabled Включает или отключает веб-API для <entity name>.
По умолчанию: False
Допустимые значения: True, False
Webapi/<entity name>/fields Определяет список атрибутов, разделенных запятыми, которые можно изменить с помощью веб-API.
Возможные значения:
- Все атрибуты: *
- Конкретные атрибуты: attr1,attr2,attr3
Примечание. Значение должно быть звездочкой (*_) или список имен полей, разделенных запятыми.
_
Важно
. Это обязательная настройка сайта. Если этот параметр отсутствует, вы увидите ошибку «Для этой сущности не определены поля».
Webapi/error/innererror Включает или отключает InnerError.
По умолчанию: False
Допустимые значения: True, False

Примечание

Настройки сайта должны быть установлены на Активно, чтобы изменения вступили в силу.

Например, чтобы предоставить веб-API для сущности обращения, где аутентифицированным пользователям разрешено выполнять операции создания, обновления и удаления для этой сущности, настройки сайта показаны в следующей таблице.

Имя настройки сайта Значение параметра сайта
Webapi/incident/enabled true
Webapi/incident/fields attr1,attr2,attr3

Безопасность с помощью веб-API порталов

Можно настроить безопасность на основе записей для отдельных записей на порталах с помощью разрешений сущности. Веб-API порталов получает доступ к записям сущностей и следует разрешениям сущностей, предоставленным пользователям через связанную веб-роль.

Безопасность веб-API порталов

Аутентификация запросов веб-API порталов

Вам не нужно включать код аутентификации, потому что аутентификация и авторизация управляются сеансом приложения. Все вызовы веб-API должны включать токен подделки межсайтовых запросов (CSRF).

Общий регламент по защите данных (GDPR)

Все заголовки запросов будут иметь идентификатор контакта, переданный для целей аудита. Для анонимного пользователя это будет передано как null.

Если ведение журнала аудита включено, пользователь может видеть все события аудита в журнале аудита Office 365.

Журнал аудита Office 365

Дополнительные сведения:
Включение и использование журнала действий
Экспорт, настройка и просмотр записей журнала аудита.

Неподдерживаемые сущности конфигурации

Веб-API порталов нельзя использовать для следующих сущностей конфигурации.

adx_contentaccesslevel adx_redirect adx_webpage_tag
adx_contentsnippet adx_setting adx_webpageaccesscontrolrule
adx_entityform adx_shortcut adx_webpageaccesscontrolrule_webrole
adx_entityformmetadata adx_sitemarker adx_webpagehistory
adx_entitylist adx_sitesetting adx_webpagelog
adx_entitypermission_webrole adx_webfile adx_webrole_systemuser
adx_externalidentity adx_webfilelog adx_website
adx_pagealert adx_webform adx_website_list
adx_pagenotification adx_webformmetadata adx_website_sponsor
adx_pagetag adx_webformsession adx_websiteaccess
adx_pagetag_webpage adx_webformstep adx_websiteaccess_webrole
adx_pagetemplate adx_weblink adx_websitebinding
adx_portallanguage adx_weblinkset adx_websitelanguage
adx_publishingstate adx_webnotificationentity adx_webtemplate
adx_publishingstatetransitionrule adx_webnotificationurl adx_urlhistory
adx_publishingstatetransitionrule_webrole adx_webpage adx_entitypermission

Известные проблемы

В текущем выпуске операции веб-API не блокируются на сущностях конфигурации. Однако эта проблема будет устранена в следующих выпусках.

Следующий шаг

Выполнение операций веб-API

См. также

Создание HTTP-запросов и обработка ошибок

Примечание

Каковы ваши предпочтения в отношении языка документации? Пройдите краткий опрос (обратите внимание, что этот опрос представлен на английском языке).

Опрос займет около семи минут. Личные данные не собираются (заявление о конфиденциальности).