Visión xeral da API web dos portais
Nota
A partir do 12 de outubro de 2022, Portais de Power Apps é Power Pages. Máis información: Microsoft Power Pages xa está dispoñible de forma xeral (blog)
Proximamente migraremos e uniremos a documentación de Portais de Power Apps coa documentación de Power Pages.
A API web dos portais permite unha experiencia de usuario máis rica dentro das páxinas dos portais de Power Apps. Pode usar a API web para realizar operacións de creación, lectura, actualización e eliminación en todas as táboas de Microsoft Dataverse das páxinas do 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 a API web dos portais 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. O uso da API web dos portais para integrarse con outros sitios dos portais de Power Apps tampouco é compatible.
- 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, vaia a táboas de configuración non compatibles, máis adiante neste tema.
- A API web dos portais benefíciase do almacenamento na caché do lado do servidor, de xeito 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 dos portais requiren unha licenza de portais de Power Apps. 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 similar posible para reducir a curva de aprendizaxe.
Nota
As operacións da API web distinguen entre maiúsculas e minúsculas.
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 de nivel de campo que determine os campos da táboa que se poden modificar ou non coa API web dos portais.
Nota
Use o nome lóxico da táboa para esta configuración (por exemplo conta).
| 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 |
| Webapi/<table name>/disableodatafilter | Activa ou desactiva o filtro de OData. Valor predefinido: False Valores válidos: True, False Consulte Problemas coñecidos para obter máis información. A configuración do sitio está dispoñible na versión do portal 9.4.10.74 ou posteriores. |
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 dos portais accede aos rexistros de táboas (entidades) e segue os permisos de táboa dados aos usuarios a través da función web asociada.
Pode configurar permisos de columna para definir aínda máis os privilexios para as columnas individuais dentro dunha táboa mentres utiliza a API web dos portais.
Autenticación das solicitudes da API web dos portais
Non precisa incluír un código de autenticación, porque a sesión da aplicación xestiona a autenticación e a autorización. Todas as chamadas da API web deben incluír un token Cross-Site Request Forgery (CSRF).
Usar EntitySetName
Cando faga referencia a táboas de Dataverse usando a API web dos portais no seu código, cómpre usar EntitySetName, por exemplo, para acceder á táboa de conta, a sintaxe do código usará EntitySetName de contas; /_api/accounts().
Nota
Use o nome lóxico da táboa para a configuración do sitio (por exemplo, conta).
Pode determinar o valor de EntitySetName de táboas específicas seguindo estes pasos:
Vaia a https://make.powerapps.com
Seleccione o separador de Dataverse desde o panel lateral e seleccione a táboa.
Seleccione ... (opción Comandos) e despois escolla Avanzado, Ferramentas e Copiar nome do conxunto para copiar o valor de EntitySetName da táboa ao portapapeis.
Regulamento xeral de protección de datos (RXPD)
Todas as cabeceiras de solicitude terán unha identificación 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:
Activar e utilizar o rexistro de actividades
Exportar, configurar e ver rexistros de auditoría
Táboas de configuración non compatibles
A API web dos 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
Problemas coñecidos
Os usuarios recibirán un erro de CDS se invocan unha solicitude GET da API web para táboas que teñen varios niveis de permisos de táboa de 1 a varios ou de varios a varios co ámbito primario definido.
Para resolver este problema, a solución recomendada é usar FetchXML na consulta de OData.
Alternativamente, estableza a configuración do sitio Webapi/<table name>disableodatafilter en True.
Importante
Ao cambiar a configuración do sitio Webapi/<table name>/disableodatafilter a True, o rendemento pode reducirse para as chamadas GET da API web.
A configuración do sitio está dispoñible na versión do portal 9.4.10.74 ou posteriores.
Seguinte paso
Consultar datos mediante a API web de portais
Consulte tamén
Redactar solicitudes HTTP e xestionar erros
Operacións de escritura, actualización e eliminación de portais mediante a API web
Titorial: usar a API web dos portais
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).
Comentarios
Proximamente: Ao longo de 2024, retiraremos gradualmente GitHub Issues como mecanismo de comentarios sobre o contido e substituirémolo por un novo sistema de comentarios. Para obter máis información, consulte: https://aka.ms/ContentUserFeedback.
Enviar e ver os comentarios