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, pots crear un compte nou o actualitzar un contacte sense utilitzar un formulari o formulari de diversos passos utilitzant l'API web del portal.

L'API web utilitza la /_api ruta (per exemple, https://yoursite.powerappsportals.com/_api/accounts) i segueix un patró RESTful similar al de l'API web de Dataverse.

Important

  • 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. No es suporta utilitzar l'API web del portal per integrar-se amb altres llocs de Power Pages.
  • Les operacions de l'API web de portals es limiten a les taules relacionades amb les dades, per exemple, comptes, contactes o taules personalitzades. La configuració de metadades de taules o dades de taules de configuració de portals—per exemple, configurar taules de portals com adx_contentsnippet, adx_entityform o adx_entitylist—no és compatible amb l'ús de l'API web del portal. Per a una llista completa, vegeu les taules de configuració no suportades 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 trucades a l'API web realitzades per usuaris anònims compten per a la capacitat d'usuari anònim. Les trucades a l'API web realitzades per usuaris autenticats (interns o externs) no compten per a les visualitzacions de pàgina, però requereixen llicències de capacitat d'usuari autenticades aplicables. Per a més informació, consulteu les preguntes freqüents sobre llicències de Power Pages.
  • No es suporta cridar accions i funcions mitjançant l'API web del portal.

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. El format de l'API és tan similar com sigui 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

Configuració del lloc per a l'API web.

Important

El suport per al valor comodí (*) en la Webapi/<table-name>/fields configuració del lloc està obsolet.

Substitueix * per una llista separada per comes de les columnes que requereix el teu lloc. Les sol·licituds de l'API web de Power Pages per a taules configurades amb * fallen fins que no configures noms explícits de columnes.

Per activar l'API web del portal per al teu portal, activa la configuració del lloc. També pots configurar l'API web a nivell de camp que determina els camps de taula que els usuaris poden o no poden modificar utilitzant l'API web del portal.

Nota

Utilitza el nom lògic de la taula per a aquestes configuracions (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 els usuaris poden modificar utilitzant l'API web.
Valors possibles:
- Atributs específics:attr1,attr2,attr3
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

Per exemple, per exposar l'API web de la taula de casos on els usuaris autenticats poden crear, actualitzar i eliminar registres per a aquesta entitat, utilitzeu la configuració del lloc que 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 atr1, atir2, atrèst3

Seguretat amb l'API web de portals

Pots configurar la seguretat basada en registres per a registres individuals en portals utilitzant 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 et refereixis a les taules de Dataverse utilitzant l'API web del portal al teu codi, utilitza l'EntitySetName. Per accedir a la taula de comptes , per exemple, 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 de taules específiques, segueix aquests passos:

  1. Vés al https://make.powerapps.com

  2. Seleccioneu la pestanya Dataverse a la subfinestra lateral i seleccioneu la taula.

  3. Selecciona l'opció ... (Ordres), i després tria Avançat, Eines i Copiar el nom del conjunt per copiar el nom d'EntitatSetName de la taula al teu portapapalles.

    Com localitzar l'EntitySetName d'una taula del Dataverse.

Lleis i normatives de privadesa

Totes les capçaleres de sol·licitud utilitzen un ID de contacte per a finalitats d'auditoria. Per a un usuari anònim, el valor és 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.

Captura de pantalla del registre d'auditoria 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, utilitzeu FetchXML a la consulta OData.

Pas següent

Consulta de dades mitjançant l'API web de portals