Visión xeral da API web dos portais

A API web de portais permite unha experiencia de usuario máis rica dentro Power Apps páxinas de portais. Podes usar a API web para realizar operacións de creación, lectura, actualización e eliminación en todos Microsoft Dataverse táboas das páxinas dos seus portais. Por exemplo, pode crear unha nova conta, actualizar un contacto ou cambiar os permisos de táboa dun produto usando a API web de portais en lugar da aplicación de xestión de portais.

Nota

Tamén pode usar portais Web API en Power Pages. Máis información: Que é Power Pages

Importante

• A súa versión do portal debe ser 9.3.3.x ou posterior para que esta función funcione.
• A API web de portais construíuse para crear unha experiencia de usuario rica dentro de páxinas de portais. Non está optimizado para servizos de terceiros nin a integración de aplicacións.
• As operacións da API web de portais están limitadas a táboas relacionadas cos datos; por exemplo, contas, contactos ou as súas táboas personalizadas. A configuración dos metadatos da táboa ou os datos da táboa de configuración do portal —por exemplo, configurar táboas de portais como adx_contentsnippet, adx_entityform ou adx_entitylist— non se admite coa API web de portais. Para obter unha lista completa, vai a táboas de configuración non compatibles máis adiante neste tema.
• A API web dos portais se beneficia caché do lado do servidor, polo que as chamadas posteriores á API web son máis rápidas que as chamadas iniciais. Teña en conta que a limpeza na almacenamento na caché do servidor do portal provoca unha degradación temporal do rendemento.
• As operacións da API web de portais requiren a Power Apps licenza de portais. Por exemplo, as chamadas da API web realizadas por usuarios anónimos descóntanse da capacidade de visualización de páxina. As chamadas da API web realizadas por usuarios autenticados (internos ou externos) non se restan das visualizacións das páxina, pero requiren licenzas aplicables. Máis información: Preguntas frecuentes das licenzas de portais de Power Apps

Operacións da API web

A API web de portais ofrece un subconxunto de capacidades para operacións de Dataverse que pode facer usando a API de Dataverse. Mantivemos o formato da API o máis semellante posible para reducir a curva de aprendizaxe.

Operacións da API web dispoñibles nos portais

• Ler rexistros dunha táboa
• Crear un rexistro nunha táboa
• Actualizar e eliminar rexistros nunha táboa
• Asociar e desvincular táboas

Configuración do sitio para a API web

Debe activar a configuración do sitio para activar a API web dos portais do seu portal. Tamén pode configurar a API web a nivel de campo que determina os campos da táboa que se poden ou non modificar coa API web de portais.

Nome da configuración do sitio	Descripción
Webapi/<table name>/enabled	Activa ou desactiva a API web para <table name>. Valor predefinido: False Valores válidos: True, False
Webapi/<table name>/fields	Define a lista de atributos separados por comas que se poden modificar coa API web. Valores posibles: - Todos os atributos: * - Atributos específicos: attr1,attr2,attr3 Nota: O valor debe ser un asterisco (*_) ou unha lista de nomes de campo separados por comas. _ Importante: esta é unha configuración de sitio obrigatoria. Cando falte esta configuración, verá o erro "Non hai campos definidos para esta entidade".
Webapi/error/innererror	Activa ou desactiva InnerError. Valor predefinido: False Valores válidos: True, False

Nota

Debe configurarse a configuración do sitio en Activo para que os cambios teñan efecto.

Por exemplo, para expoñer a API web da táboa de caso onde os usuarios autenticados poden realizar operacións de creación, actualización e eliminación desta entidade, a configuración do sitio móstrase na seguinte táboa.

Nome da configuración do sitio	Valor de configuración do sitio
Webapi/incident/enabled	verdadeiro
Webapi/incident/fields	attr1, attr2, attr3

Seguridade coa API web de portais

Pode configurar a seguridade baseada en rexistros para rexistros individuais en portais usando permisos de táboa. A API web de portais accede aos rexistros da táboa (entidade) e segue os permisos da táboa concedidos aos usuarios a través dos rol web.

Podes configurar permisos de columna para definir aínda máis privilexios para columnas individuais dentro dunha táboa mentres usa a API web de portais.

Autenticación das solicitudes da API web dos portais

Non é necesario incluír un código de autenticación, porque a autenticación e a autorización son xestionadas pola sesión da aplicación. Todas as chamadas da API web deben incluír un token Cross-Site Request Forgery (CSRF).

Usando EntitySetName

Cando se refire Dataverse táboas usando a API web de portais, cómpre usar o EntitySetName, por exemplo, para acceder ao conta táboa, a sintaxe do código usará o EntitySetName de contas.

Podes determinar o EntitySetName de táboas específicas seguindo estes pasos:

1. Vaia a https://make.powerapps.com

2. Seleccione o Dataverse desde o panel lateral e seleccione a táboa.

3. Seleccione o ... (Opción Comandos) e despois escolla Avanzado, ·, e Copiar o nome do conxunto para copiar EntitySetName da mesa ao portapapeis.

   

Regulamento xeral de protección de datos (RXPD)

Todas as cabeceiras das solicitudes terán un ID de contacto para fins de auditoría. Para un usuario anónimo, pasarase como null.

Se o rexistro de auditoría está activado, un usuario pode ver todos os eventos de auditoría no Rexistro de auditoría de Office 365.

Máis información:
Activa e utiliza o rexistro de actividade
Exportar, configurar e ver rexistros de rexistro de auditoría

Táboas de configuración non compatibles

A API web de portais non se pode usar para as seguintes táboas de configuración:

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

Seguinte paso

Consulta datos mediante a API web de portais

Consulte tamén

Redactar solicitudes HTTP e xestionar erros
Os portais escriben, actualizan e eliminan operacións mediante a API web
Titorial: Usa a API web do portal

Nota

Pode indicarnos as súas preferencias para o idioma da documentación? Realice unha enquisa breve. (teña en conta que esa enquisa está en inglés)

Esta enquisa durará sete minutos aproximadamente. Non se recompilarán datos persoais (declaración de privacidade).