Informació general sobre l'API web de portals
Nota
Des del 12 d'octubre de 2022, els portals del Power Apps són Power Pages. Més informació: Microsoft Power Pages ara està disponible de manera general (bloc)
Ben aviat migrarem i combinarem la documentació dels portals del Power Apps amb la documentació del Power Pages.
L'API web de portals permet una experiència d'usuari més rica dins de les pàgines de portals de Power Apps. Podeu utilitzar l'API web per dur a terme les operacions de creació, lectura, actualització i supressió a totes les taules del Microsoft Dataverse des de les pàgines dels portals. Per exemple, podeu crear un compte nou, actualitzar un contacte o canviar els permisos de taula per a un producte mitjançant l'API web de portals en comptes de l'aplicació Administració del portal.
Nota
També podeu utilitzar l'API web dels portals al Power Pages. Més informació: Què és Power Pages.
Important
- La versió del portal ha de ser 9.3.3.x o posterior per poder treballar amb aquesta característica.
- L'API web de portals està feta per crear una experiència d'usuari rica dins de les pàgines de portals. No s'ha optimitzat per a serveis o d'integració d'aplicacions de tercers. L'ús de l'API web dels portals per integrar-se amb altres llocs de portals del Power Apps tampoc no està admès.
- Les operacions de l'API web de portals es limiten a les taules relacionades amb les dades, per exemple, comptes, contactes o taules personalitzades. Configurar les metadades de la taula o les dades de la taula de configuració del portal, per exemple, configurant taules de portals, com ara adx_contentsnippet, adx_entityform o adx_entitylist, no està admès a l'API web dels portals. Per veure una llista completa, aneu a les taules de configuració no admeses, més endavant en aquest tema.
- L'API web de portals es beneficia de la memòria cau del servidor i, per tant, les trucades posteriors a l'API web són més ràpides que les trucades inicials. Heu de tenir en compte que esborrar la memòria cau del servidor del portal provoca una degradació de rendiment temporal.
- Les operacions de l'API web de portals necessiten una llicència de portals del Power Apps. Per exemple, les crides d'API web fetes per usuaris anònims es compten per a la capacitat de visualització de pàgina. Les crides d'API web fetes per usuaris autenticats (interns o externs) no es compten per a les visualitzacions de pàgina, però requereixen llicències aplicables. Més informació: Preguntes més freqüents sobre les llicències dels portals del Power Apps
Operacions de l'API web
L'API web de portals ofereix un subconjunt de capacitats per a les operacions de Dataverse que podeu fer mitjançant l'API de Dataverse. Hem mantingut el format de l'API el més similar possible per reduir la corba d'aprenentatge.
Nota
Les operacions de l'API web distingeixen les majúscules de les minúscules.
Operacions de l'API web disponibles als portals
- Llegir registres d'una taula
- Crear un registre en una taula
- Actualitzar i suprimir registres d'una taula
- Associar i anul·ar l'associació de taules
Configuració del lloc per a l'API web.
Heu d'habilitar la configuració del lloc per habilitar l'API web de portals per al vostre portal. També podeu configurar l'API web de nivell de camp que determina els camps de taula que es poden o no es poden modificar amb l'API web de portals.
Nota
Utilitzeu el nom lògic de la taula per a aquesta configuració (per exemple, compte).
| Nom de la configuració del lloc | Descripció |
|---|---|
| Webapi/<table name>/enabled | Habilita o inhabilita l'API web per a <table name>. Per defecte: False Valors vàlids: True False |
| Webapi/<table name>/fields | Defineix la llista d'atributs separats per comes que es pot modificar amb l'API web. Valors possibles: - Tots els atributs: * - Atributs específics: attr1,attr2,attr3 Nota: el valor ha de ser o bé un asterisc (*) o una llista separada per comes de noms de camp. Important: aquest és un paràmetre de lloc obligatori. Quan aquesta opció no hi sigui, veureu l'error "No s'ha definit cap camp per a aquesta entitat". |
| Webapi/error/innererror | Habilita o inhabilita InnerError. Per defecte: False Valors vàlids: True False |
| Webapi/<table name>/disableodatafilter | Habilita o inhabilita el filtre OData. Per defecte: False Valors vàlids: True, False Per obtenir més informació, vegeu Problemes coneguts. La configuració del lloc està disponible a la versió 9.4.10.74 del portal o posterior. |
Nota
La configuració del lloc s'ha de definir en Actiu perquè els canvis tinguin efecte.
Per exemple, per exposar l'API web de la taula Cas on es permet als usuaris autenticats fer operacions de creació, actualització i supressió en aquesta entitat, la configuració del lloc es mostra a la taula següent.
| Nom de la configuració del lloc | Valor de configuració del lloc |
|---|---|
| Webapi/incident/enabled | true |
| Webapi/incident/fields | attr1, attr2, attr3 |
Seguretat amb l'API web de portals
Podeu configurar la seguretat basada en registres als registres individuals dels portals mitjançant permisos de taula. L'API web de portals accedeix als registres (entitat) de taula i segueix els permisos de taula atorgats als usuaris mitjançant la funció web associada.
Podeu configurar permisos de columna per definir encara més els privilegis a les columnes individuals d'una taula mentre utilitzeu l'API web de portals.
Autenticar les sol·licituds de l'API web dels portals
No cal que inclogueu un codi d'autenticació, perquè l'autenticació i l'autorització són gestionats per la sessió de l'aplicació. Totes les trucades de l'API web han d'incloure un testimoni de falsificació de sol·licitud entre llocs (CSRF).
Ús d'EntitySetName
Quan feu referència a taules del Dataverse que utilitzen l'API web de portals al codi, heu d'utilitzar EntitySetName; per exemple, per accedir a la taula compte, la sintaxi de codi utilitzarà l'EntitySetName comptes; /_api/accounts().
Nota
Utilitzeu el nom lògic de la taula per a la configuració del lloc (per exemple, compte).
Per determinar l'EntitySetName d'una taula específica, seguiu aquests passos:
Vés al https://make.powerapps.com
Seleccioneu la pestanya Dataverse a la subfinestra lateral i seleccioneu la taula.
Seleccioneu ... (opció d'ordres) i, a continuació, trieu Avançat,Eines i Copia el nom del conjunt per copiar l'EntitySetName de la taula al porta-retalls.
Reglament General de Protecció de Dades (GDPR)
Tots els encapçalaments de sol·licitud tindran un identificador de contacte aprovat per a finalitats d'auditoria. Per a un usuari anònim, això s'aprovarà com a null.
Si el registre d'auditoria està habilitat, l'usuari pot veure totes les incidències d'auditoria al registre d'auditoria d'Office 365.
Més informació:
Habilitar i utilitzar el registre d'activitats
Exportar, configurar i visualitzar registres del registre d'auditoria
Taules de configuració no admeses
L'API web de portals no es pot utilitzar per a les taules de configuració següents:
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
Problemes coneguts
Els usuaris rebran un error de CDS si invoquen una sol·licitud GET de l'API web per a taules que tenen diversos nivells de permisos de taula 1 a diversos o diversos a diversos amb l'àmbit principal definit.
Per resoldre aquest problema, la solució recomanada és utilitzar FetchXML a la consulta OData.
O bé, definiu el paràmetre de lloc Webapi/<table name>/disableodatafilter com a True.
Important
Canviar el paràmetre del lloc webapi/<table name>/disableodatafilter a True pot tenir com a conseqüència un rendiment més lent per a les trucades GET de l'API web.
La configuració del lloc està disponible a la versió 9.4.10.74 del portal o posterior.
Pas següent
Consultes de dades amb l'API web de portals
Consulteu també
Redactar sol·licituds HTTP i gestionar els errors
Operacions d'escriptura, actualització i supressió al Portals amb l'API web
Tutorial: Utilitzar l'API web del portal
Nota
Ens podeu dir quines són les vostres preferències d'idioma per a la documentació? Responeu una breu enquesta. (tingueu en compte que l'idioma de l'enquesta és l'anglès)
Trigareu uns set minuts a completar l'enquesta. No es recopilen dades personals (declaració de privadesa).