Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
La API web de los portales permite una experiencia de usuario más completa en los sitios de Power Pages. Puede utilizar la API web para realizar las operaciones de crear, leer, actualizar y eliminar en todas las tablas de Microsoft Dataverse de sus páginas web. Por ejemplo, puede crear una cuenta nueva o actualizar un contacto sin usar un formulario o formulario de varios pasos mediante la API web de portales.
La API web usa la /_api ruta (por ejemplo, https://yoursite.powerappsportals.com/_api/accounts) y sigue un patrón RESTful similar a la API web de Dataverse.
Importante
- La API web de los portales se ha diseñado para crear una experiencia de usuario rica en páginas de portales. No está optimizado para servicios de terceros o integración de aplicaciones. No se admite el uso de la API web de portales para la integración con otros sitios de Power Pages.
- Las operaciones de la API web de los portales se limitan a tablas relacionadas con los datos, por ejemplo, cuentas, contactos o sus tablas personalizadas. La configuración de metadatos de tabla o datos de tabla de configuración del portal( por ejemplo, la configuración de tablas de portales como adx_contentsnippet, adx_entityform o adx_entitylist) no se admite mediante la API web de portales. Para obtener una lista completa, consulte tablas de configuración no admitidas más adelante en este artículo.
- La API web de los portales se beneficia del almacenamiento en caché del lado del servidor, por lo que las llamadas posteriores a la API web son más rápidas que las llamadas iniciales. Borrar la memoria caché del lado del servidor del portal provoca una degradación temporal del rendimiento.
- Las operaciones de la API web de los portales requieren una licencia de Power Pages. Por ejemplo, las llamadas api web realizadas por usuarios anónimos cuentan para la capacidad de usuario anónima. Las llamadas api web realizadas por usuarios autenticados (internos o externos) no cuentan con vistas de página, pero requieren licencias de capacidad de usuario autenticadas aplicables. Para obtener más información, consulte Power Pages preguntas más frecuentes sobre licencias.
- No se admite la llamada a acciones y funciones mediante la API web de portales.
Operaciones de API web
La API web de los portales ofrece un subconjunto de las capacidades para realizar operaciones en Dataverse que se pueden llevar a cabo mediante la API de Dataverse. El formato de API es lo más similar posible para reducir la curva de aprendizaje.
Nota
Las operaciones de API web distinguen entre mayúsculas y minúsculas.
Operaciones de API web disponibles en Power Pages
- Leer registros de una tabla
- Crear un registro en una tabla
- Actualizar y eliminar registros en una tabla
- Asociar y desasociar tablas
Configuración del sitio para la API web
Importante
La compatibilidad con el valor comodín (*) en la configuración del Webapi/<table-name>/fields sitio está en desuso.
Reemplace por * una lista separada por comas de las columnas necesarias para el sitio. Power Pages solicitudes de API web para tablas configuradas con * error hasta que se configuran nombres de columna explícitos.
Para habilitar la API web de portales para el portal, active la configuración del sitio. También puede configurar la API web de nivel de campo que determina los campos de tabla que los usuarios pueden o no pueden modificar mediante la API web de portales.
Nota
Use el nombre lógico de la tabla para esta configuración (por ejemplo, cuenta).
| Nombre de la configuración del sitio | Descripción |
|---|---|
| Webapi/<nombre de tabla>/habilitado | Habilita o deshabilita la API web para <nombre de tabla>. Predeterminada: False Valores válidos: True, False |
| Webapi/<nombre de tabla>/fields | Define la lista separada por comas de atributos que los usuarios pueden modificar mediante la API web. Valores posibles: - Atributos específicos: attr1,attr2,attr3 Importante: Esta configuración es una configuración de sitio obligatoria. Cuando falta esta configuración, verá el error "No hay campos definidos para esta entidad". |
| Webapi/error/innererror | Habilita o deshabilita InnerError. Predeterminada: False Valores válidos: True, False |
Por ejemplo, para exponer la API web para la tabla Case donde los usuarios autenticados pueden crear, actualizar y eliminar registros para esta entidad, use la configuración del sitio que se muestra en la tabla siguiente.
| Nombre de la configuración del sitio | Valor de configuración del sitio |
|---|---|
| Webapi/incident/enabled | verdadero |
| Webapi/incident/fields | attr1, attr2, attr3 |
Seguridad con la API web de los portales
Puede configurar la seguridad basada en registros para registros individuales en portales mediante permisos de tabla. La API web de los portales accede a los registros de la tabla (entidad) y sigue los permisos de la tabla otorgados a los usuarios a través de los roles web asociados.
Puede configurar permisos de columna para definir aún más los privilegios de las columnas individuales de una tabla mientras usa la API web de portales.
Autenticación de solicitudes de API web de portales
No es necesario que incluya un código de autenticación, ya que la sesión de la aplicación administra la autenticación y la autorización. Todas las llamadas a la API web deben incluir un token de falsificación de solicitud entre sitios (CSRF).
Uso de EntitySetName
Al hacer referencia a tablas de Dataverse mediante la API web de portales en el código, use EntitySetName. Para tener acceso a la tabla de cuentas , por ejemplo, la sintaxis de código usa EntitySetName de cuentas; /_api/accounts().
Nota
Use el nombre lógico de la tabla para la configuración del sitio (por ejemplo, cuenta).
Para determinar EntitySetName de tablas específicas, siga estos pasos:
Seleccione la pestaña Dataverse del panel lateral y seleccione la tabla.
Seleccione la opción ... (Comandos) y, a continuación, elija Opciones avanzadas, Herramientas y Copiar nombre del conjunto para copiar entitySetName de la tabla en el Portapapeles.
Leyes y regulaciones de privacidad
Todos los encabezados de solicitud usan un identificador de contacto con fines de auditoría. Para un usuario anónimo, el valor es null.
Si el registro de auditoría está habilitado, un usuario puede ver todos los eventos de auditoría en el registro de auditoría de Office 365.
Más información:
Habilitar y utilizar registro de actividad
Exportar, configurar y ver registros de auditoría
Tablas de configuración no admitidas
La API web de Portals no se puede utilizar para las siguientes tablas 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
Problemas conocidos
Los usuarios reciben un error de CDS si invocan una solicitud a la API web GET para tablas que tienen múltiples niveles de uno a varios o varios a variospermisos de tabla cuando los ámbitos Principal, **Contacto o Cuenta agregan más condiciones a la consulta.
Para resolver este problema, use FetchXML en la consulta OData.
Siguiente paso
Consultar datos utilizando la API web de portales