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 dei portali per creare, leggere, aggiornare ed eliminare le tabelle Microsoft Dataverse dalle pagine delle tue pagine Web. Ad esempio, puoi creare un nuovo account, aggiornare un contatto, senza utilizzare un modulo o modulo a più passaggi da utilizzando l'API Web dei portali.

Importante

  • La versione del sito Power Pages deve essere 9.3.3.x o successiva affinché questa funzionalità sia operativa.
  • 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. Anche l'utilizzo dell'API Web dei portali per l'integrazione con altri siti Power Pages non è supportato.
  • Le operazioni API Web dei portali sono limitate alle tabelle relative ai dati, ad esempio, account, contatti o tabelle personalizzate. Configurazione dei metadati della tabella o dei dati della tabella di configurazione del portale, ad esempio, la configurazione di tabelle di portali come adx_contentsnippet, adx_entityform o adx_entitylist non è supportato con l'API Web dei portali. Per un elenco completo, vai alle tabelle di configurazione non supportate più avanti in questo argomento.
  • L'API web dei portali usa la cache lato server, quindi le chiamate successive all'API Web sono più veloci delle chiamate iniziali. Tieni presente che 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 da utenti anonimi vengono conteggiate ai fini della capacità utente anonima. Le chiamate API Web effettuate da utenti autenticati (interni o esterni) non vengono conteggiate ai fini delle visualizzazioni di pagina, ma richiedono licenze relative alla capacità utente autenticato applicabili. Ulteriori informazioni: Domande frequenti sulle licenze di Power Pages

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. Abbiamo mantenuto il formato delle 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

Nota

L'uso dell'API Web dei portali non è supportato con la chiamata di azioni e funzioni.

Impostazioni del sito per l'API Web

È necessario abilitare l'impostazione del sito per abilitare l'API Web dei portali per il portale. È inoltre possibile configurare l'API Web a livello di campo che determina i campi della tabella che possono o non possono essere modificati con l'API Web dei portali.

Nota

Usa il nome logico della tabella per queste impostazioni (ad esempio account).

Nome impostazione sito Descrizione
Webapi/<table name>/enabled Abilita o disabilita l'API Web per <table name>.
Impostazione predefinita:False
Valori validi:True, False
Webapi/<table name>/fields Definisce l'elenco di attributi separati da virgole che possono essere modificati con l'API Web.
Valori possibili:
- Tutti gli attributi:*
- Attributi specifici:attr1,attr2,attr3
Nota: il valore deve essere un asterisco (*) o un elenco separato da virgole di nomi di campo.
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
Webapi/<table name>/disableodatafilter Abilita o disabilita il filtro OData.
Impostazione predefinita:False
Valori validi:True, False Vedi problemi noti per ulteriori informazioni. L'impostazione del sito è disponibile nella versione 9.4.10.74 o successiva del portale.

Nota

Le impostazioni del sito devono essere impostate su Attivo affinché le modifiche abbiano effetto.

Ad esempio, per esporre l'API Web per la tabella Caso in cui agli utenti autenticati è consentito eseguire operazioni di creazione, aggiornamento ed eliminazione in questa entità, le impostazioni del sito vengono mostrate nella tabella seguente.

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

Sicurezza con l'API Web dei portali

Puoi configurare la protezione basata su record per singoli record nei portali utilizzando autorizzazioni di tabella. 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, poiché l'autenticazione e l'autorizzazione sono gestite dalla sessione dell'applicazione. Tutte le chiamate API Web devono includere un token CSRF (Cross-Site Request Forgery, richiesta intersito falsa).

Utilizzo di EntitySetName

Quando si fa riferimento alle tabelle Dataverse utilizzando l'API Web dei portali nel codice, è necessario utilizzare EntitySetName, ad esempio, per accedere alla tabella account, la sintassi del codice utilizzerà EntitySetName di account; /_api/accounts().

Nota

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

Puoi determinare la proprietà EntitySetName di tabelle specifiche seguendo questi passaggi:

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

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

  3. Seleziona ... (Opzione comandi) e quindi sceglie Avanzate, Strumenti e Copia il nome del set per copiare EntitySetName della tabella negli Appunti.

    Come individuare EntitySetName di una tabella Dataverse.

Leggi e regolamenti sulla privacy

Tutte le intestazioni delle richieste avranno un ID contatto passato a scopo di controllo. Per un utente anonimo, questo verrà trasmesso come null.

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

Log di controllo 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 visualizzeranno un errore CDS della richiesta dell'API Web GET per le tabelle con più livelli di autorizzazioni da 1 a molti o molti a moltiper le tabelle se gli ambiti Con elemento padre, Contatto o Account aggiungono ulteriori condizioni alla query.

Per risolvere questo problema, la soluzione consigliata è utilizzare FetchXML nella query OData.

In alternativa, imposta l'impostazione del sito Webapi/<table name>/disableodatafilter su True.

Importante

La modifica dell'impostazione del sito Webapi/<table name>/disableodatafilter su True può comportare un rallentamento delle prestazioni per le chiamate GET dell'API Web.

L'impostazione del sito è disponibile nella versione 9.4.10.74 o successiva del portale.

Passaggio successivo

Query di dati utilizzando l'API Web dei portali

Vedi anche