Panoramica dell'API Web dei portali

L'API Web dei portali consente un'esperienza utente più ricca all'interno delle pagine dei siti Power Pages. Puoi utilizzare l'API Web per eseguire operazioni di creazione, lettura, aggiornamento ed eliminazione in tutte le tabelle di Microsoft Dataverse dalle tue pagine Web. Ad esempio, è possibile creare un nuovo account o aggiornare un contatto senza usare un modulo o un modulo con più passaggi usando l'API Web portals.

L'API Web usa la /_api route ,ad esempio https://yoursite.powerappsportals.com/_api/accounts, e segue un modello RESTful simile all'API Web Dataverse.

Importante

  • L'API Web dei portali è progettata per creare un'esperienza utente più ricca nelle pagine dei portali. Non è ottimizzata per servizi di terze parti o integrazione di applicazioni. L'uso dell'API Web portals per l'integrazione con altri siti di Power Pages non è supportato.
  • Le operazioni API Web dei portali sono limitate alle tabelle relative ai dati, ad esempio, account, contatti o tabelle personalizzate. La configurazione dei metadati della tabella o dei dati della tabella di configurazione del portale, ad esempio la configurazione di tabelle del portale, ad esempio adx_contentsnippet, adx_entityform o adx_entitylist, non è supportata tramite l'API Web portals. Per un elenco completo, vedere tabelle di configurazione non supportate più avanti in questo articolo.
  • L'API web dei portali usa la cache lato server, quindi le chiamate successive all'API Web sono più veloci delle chiamate iniziali. La cancellazione della cache lato server del portale provoca un degrado temporaneo delle prestazioni.
  • Le operazioni dell'API Web dei portali richiedono una licenza per Power Pages. Ad esempio, le chiamate API Web effettuate dagli utenti anonimi contano per la capacità utente anonima. Le chiamate API Web effettuate dagli utenti autenticati (interni o esterni) non vengono conteggiate per le visualizzazioni di pagina, ma richiedono licenze di capacità utente autenticate applicabili. Per altre informazioni, vedere Power Pages domande frequenti sulle licenze.
  • La chiamata di azioni e funzioni tramite l'API Web portals non è supportata.

Operazioni dell'API Web

L'API Web dei portali offre un sottoinsieme di funzionalità per le operazioni di Dataverse che puoi eseguire utilizzando l'API Dataverse. Il formato api è il più simile possibile per ridurre la curva di apprendimento.

Nota

Le operazioni dell'API Web fanno distinzione tra maiuscole e minuscole.

Operazioni dell'API Web disponibili in Power Pages

Impostazioni del sito per l'API Web

Importante

Il supporto per il valore con caratteri jolly (*) nell'impostazione del Webapi/<table-name>/fields sito è deprecato.

Sostituire * con un elenco delimitato da virgole delle colonne richieste dal sito. Power Pages richieste api Web per le tabelle configurate con * esito negativo fino a quando non si configurano nomi di colonna espliciti.

Per abilitare l'API Web portals per il portale, attivare l'impostazione del sito. È anche possibile configurare l'API Web a livello di campo che determina i campi della tabella che gli utenti possono o non possono modificare usando l'API Web portals.

Nota

Usare il nome logico della tabella per queste impostazioni, ad esempio account.

Nome dell'impostazione del sito Descrizione
Webapi/<nome tabella>/abilitato Abilita o disabilita l'API Web per <table name>.
Impostazione predefinita:False
Valori validi:True, False
Webapi/<nome> tabella/campi Definisce l'elenco delimitato da virgole di attributi che gli utenti possono modificare usando l'API Web.
Valori possibili:
- Attributi specifici:attr1,attr2,attr3
Importante: questa è un'impostazione sito obbligatoria. Quando questa impostazione è mancante, verrà visualizzato l'errore "Nessun campo definito per questa entità".
Webapi/error/innererror Abilita o disabilita InnerError.
Impostazione predefinita:False
Valori validi:True, False

Ad esempio, per esporre l'API Web per la tabella Case in cui gli utenti autenticati possono creare, aggiornare ed eliminare record per questa entità, usare le impostazioni del sito illustrate nella tabella seguente.

Nome dell'impostazione del sito Valore dell'impostazione sito
Webapi/incident/enabled vero
Webapi/incident/fields attr1, attr2, attr3

Sicurezza con l'API Web dei portali

È possibile configurare la sicurezza basata su record per i singoli record nei portali usando le autorizzazioni per le tabelle. L'API Web dei portali accede ai record della tabella (entità) e segue le autorizzazioni della tabella fornite agli utenti tramite il ruolo web associato.

Puoi configurare le autorizzazioni di colonna per definire ulteriormente i privilegi delle singole colonne all'interno di una tabella durante l'utilizzo dell'API Web dei portali.

Autenticazione delle richieste dell'API Web dei portali

Non è necessario includere un codice di autenticazione, perché la sessione dell'applicazione gestisce l'autenticazione e l'autorizzazione. Tutte le chiamate alle Web API devono includere un token CSRF (Cross-Site Request Forgery).

Utilizzo di EntitySetName

Quando si fa riferimento alle tabelle di Dataverse usando l'API Web portals nel codice, usare EntitySetName. Per accedere alla tabella dell'account , ad esempio, la sintassi del codice usa EntitySetName degli account; /_api/accounts().

Nota

Usa il nome logico della tabella per le impostazioni del sito (ad esempio account).

Per determinare EntitySetName di tabelle specifiche, seguire questa procedura:

  1. Vai a https://make.powerapps.com

  2. Seleziona la scheda Dataverse dal pannello laterale e seleziona la tabella.

  3. Selezionare l'opzione ... (comandi) e quindi scegliere Avanzate, Strumenti e Copia nome set per copiare entitySetName della tabella negli Appunti.

    Come individuare EntitySetName di una tabella Dataverse.

Leggi e regolamenti sulla privacy

Tutte le intestazioni di richiesta usano un ID contatto a scopo di controllo. Per un utente anonimo, il valore è null.

Se il log di controllo è abilitato, un utente può vedere tutti gli eventi di controllo nel log di controllo di Office 365.

Schermata del registro di controllo di Office 365.

Ulteriori informazioni:
Abilitare e utilizzare la registrazione degli impegni
Esportare, configurare e visualizzare i record del log di controllo

Tabelle di configurazione non supportate

L'API Web dei portali non può essere utilizzata per le seguenti tabelle di configurazione:

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

Problemi noti

Gli utenti ricevono un errore CDS se richiamano una richiesta API Web GET per tabelle con più livelli di autorizzazioni di tabella da 1 a molti omolti a molti quando gli ambiti Parental, **Contact o Account aggiungono altre condizioni alla query.

Per risolvere questo problema, usare FetchXML nella query OData.

Passaggio successivo

Eseguire query sui dati tramite l'API Web dei portali