Introduzione all'API Web Microsoft Dataverse
API Web e Servizio organizzazione
L'API Web e il Servizio organizzazione sono i due modi principali per interagire con dati e metadati in Microsoft Dataverse. È possibile usare il Servizio organizzazione quando si scrivono i plug-in o le estensioni del flusso di usando l'SDK per .NET fornito da Microsoft.
Indipendentemente dall'approccio adottato, tutte le operazioni relative ai dati passano attraverso il servizio organizzazione sottostante. Pertanto, l'API Web consente di eseguire le stesse operazioni del Servizio organizzazione ma nello stile RESTful.
Il grafico seguente contiene un albero delle decisioni che aiuta a determinare quando usare l'API Web e quando il Servizio organizzazione (tramite gli assembly SDK disponibili nel pacchetto NuGet Microsoft.CrmSdk.CoreAssemblies). Mostra inoltre quando usare gli assembly Dataverse ServiceClient (disponibili nel pacchetto NuGet Microsoft.PowerPlatform.Dataverse.Client) per le applicazioni Windows.
Questo modulo descrive l'API Web. Per altre informazioni sul servizio organizzazione, vedere Uso del servizio Dataverse Organization nella Guida per sviluppatori di Dataverse.
OData (Open Data Protocol) 4.0
L'API Web Dataverse è implementata come servizio OData (OASIS Open Data Protocol). L'uso di uno standard di settore come questo offre tutti i vantaggi dello sviluppo con standard aperti, come la compatibilità multipiattaforma e l'implementazione semplificata con un protocollo comune e predefinito.
Dataverse non fornisce strumenti .NET specifici per l'API Web. Si consiglia di usare invece le librerie della community conformi al protocollo OData. Per altre informazioni sulle raccolte disponibili, vedere https://www.odata.org/libraries/.
OData consente di interagire con i dati Dataverse con operazioni CRUD (creazione, lettura. aggiornamento ed eliminazione) disponibili tramite i metodi HTTP standard GET, POST, PATCH e DELETE. Altre informazioni su questi metodi verranno fornite più avanti in questo modulo. È inoltre possibile eseguire quasi tutte le altre operazioni esposte con il framework degli eventi Dataverse richiamando una funzione o un'azione OData con lo stesso nome del messaggio del Servizio organizzazione corrispondente. I messaggi relativi a CRUD sono gli unici non disponibili perché usano i metodi standard HTTP descritti in precedenza.
REST
Il protocollo OData è, in sostanza, un insieme di API RESTful (Trasferimento di stato rappresentativo), uno standard di settore che fornisce l'interoperabilità tra i sistemi. REST è costituito da sei principi guida che limitano il modo in cui un servizio può elaborare e rispondere alle richieste per garantire che le proprietà non funzionali di quel servizio siano soddisfatte (come prestazioni, scalabilità, semplicità, affidabilità e così via).
Ai fini di questa lezione occorre tenere presente che OData è conforme a questi vincoli, così come l'API Web Dataverse che implementa il protocollo OData.
FetchXML
FetchXML è un affidabile linguaggio di query che consente di eseguire query complesse sui dati di Dataverse. È possibile usare FetchXML per comporre i criteri di query quando si eseguono query con l'API Web di Dataverse. Questo approccio può risultare utile in scenari di query in cui FetchXML è più adatto della sintassi della query OData. Altre informazioni su FetchXML saranno fornite in un'unità successiva di questo modulo.