Informació general sobre l'API web de portals
L'API web de portals permet una experiència d'usuari més rica dins dels llocs de Power Pages. 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 web. Per exemple, podeu crear un compte nou, actualitzar un contacte, sense utilitzar un formulari ni un formulari de diversos passos mitjançant l'API web de portals.
Important
- La versió del vostre Power Pages lloc ha de ser 9.3.3.x o posterior perquè aquesta funció funcioni.
- 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 de portals per integrar-se amb altres llocs de Power Pages tampoco no està admesa.
- 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 obtenir una llista completa, aneu a les taules de configuració no admeses més endavant en aquest article.
- 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. Esborrar la memòria cau del servidor del portal provoca una degradació temporal del rendiment.
- Les operacions de l'API web de portals necessiten una llicència de Power Pages. Per exemple, les crides d'API web fetes per usuaris anònims es compten per a la capacitat d'usuari anònim. Les trucades a l'API web fetes pels usuaris autenticats (interns o externs) no es comptabilitzen per a les visualitzacions de pàgina, però requereixen llicències de capacitat d'usuari autenticades aplicables. Més informació: Preguntes freqüents de llicència de Power Pages .
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. Vam mantenir 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 a Power Pages
- Llegir registres d'una taula
- Crear un registre en una taula
- Actualitzar i suprimir registres d'una taula
- Associar i desassociar 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/<nom de> la taula/habilitat | Habilita o inhabilita l'API web per a <nom de taula>. Omissió: False Valors vàlids: True, False |
| Webapi/<nom de> la taula/camps | 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 un asterisc (*) o una llista de noms de camp separats per comes. Important: aquesta opció de configuració és obligatòria. Quan falta aquesta configuració, veureu l'error "No s'ha definit cap camp per a aquesta entitat". |
| Webapi/error/innererror | Habilita o inhabilita InnerError. Omissió: False Valors vàlids: True, False |
| Webapi/<nom de> la taula/disableodatafilter | Habilita o inhabilita el filtre OData. Omissió: False Valors vàlids: True,Vegeu False problemes coneguts per obtenir més informació. 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/camps | 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 incloguis un codi d'autenticació perquè la sessió de l'aplicació gestiona l'autenticació i l'autorització. 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 Dataverse taules que utilitzen l'API web de portals al vostre codi, heu d'utilitzar EntitySetName, per exemple, per accedir a la taula de comptes , la sintaxi del codi utilitza l'EntitySetName dels 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.
Lleis i normatives de privadesa
Totes les capçaleres de sol·licitud utilitzen un identificador de contacte passat amb finalitats d'auditoria. Per a un usuari anònim, aquest valor es passa com 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'activitat
Exportar, configurar i visualitzar registres de 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 reben un error CDS si invoquen una GET sol·licitud d'API web per a taules que tenen diversos nivells de permisos de taula d'1 a molts omolts a molts quan els àmbits Parental, ** Contacte o Compte afegeixen més condicions a la consulta.
Per resoldre aquest problema, la solució recomanada és utilitzar-la FetchXML a la consulta OData.
O bé, definiu el valor de lloc com a Webapi/<table name>/disableodatafilter com a True.
Important
Canviar la configuració del lloc Webapi/<table name>/disableodatafilter a True pot provocar un rendiment més lent per a les trucades a l'API GET web.
La configuració del lloc està disponible a la versió 9.4.10.74 del portal o posterior.
Pas següent
Consulta de dades mitjançant l'API web de portals