Work with Dataverse Web API / Integrate with Power Platform and Dataverse

Question 1

Introduction to the Microsoft Dataverse Web API

Differenza tra l’utilizzo delle Web API e L’organization Service!

Answer 1

Web API vs. the Organization Service

Ci sono due modi principali per interagire con dati e metadati in Microsoft Dataverse sono l’API Web e il Organization Service.

• L’Organization Service viene utilizzato durante la scrittura di plug-in o workflow extensions utilizzando gli assembly .NET Framework SDK forniti da Microsoft.
  
  • Al momento della stesura di questo documento, tutte le operazioni sui dati passano attraverso il Organization Service sottostante
• l’API Web consente di eseguire le stesse operazioni del L’Organization Service ma in uno stile RESTful (ulteriori informazioni su REST verranno fornite più avanti in questo modulo).
• Il grafico seguente è un albero decisionale che può aiutarti a determinare quando utilizzare l’API Web rispetto al Organization Service (tramite gli assembly SDK) e anche quando utilizzare gli assembly degli strumenti XRM (disponibili da Microsoft) per le applicazioni Windows.

Question 2

Introduction to the Microsoft Dataverse Web API

Cosa è OData?

Answer 2

OData 4.0

Dataverse Web API implementata come servizio OData (OASIS Open Data Protocol).

• Utilizzando uno standard di settore come questo, ti vengono assegnati tutti i vantaggi dello sviluppo di standard aperti, come la compatibilità multipiattaforma e la semplice implementazione rispetto a un protocollo comune e predefinito.
• O
• Dataverse non fornisce strumenti di assembly specifici per l’API Web;
  
  • si consiglia invece di utilizzare le librerie della comunità conformi al protocollo OData.
• Data offre la possibilità di interagire con i dati Dataverse con operazioni CRUD disponibili tramite i metodi HTTP GET, POST, PATCH e DELETE standard (ulteriori informazioni su questi metodi verranno fornite più avanti in questo modulo).
  
  • È inoltre possibile eseguire quasi tutte le altre operazioni esposte tramite Dataverse Event Framework richiamando una funzione o un’azione OData con lo stesso nome del messaggio del Organization Service corrispondente.
  • I messaggi relativi a CRUD sono gli unici che non sono disponibili perché tali messaggi vengono ottenuti con i metodi HTTP standard descritti in precedenza.

Question 3

Introduction to the Microsoft Dataverse Web API

Cosa è REST?

Answer 3

REST

Fondamentalmente, il protocollo OData è un insieme di API RESTful (REpresentational State Transfer), uno standard di settore collaudato nel tempo per fornire 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, è necessario tenere presente che OData è conforme a questi vincoli e che l’API Web Common Data a sua volta è conforme ai vincoli perché implementa il protocollo OData 4.0.

Question 4

Introduction to the Microsoft Dataverse Web API

Cosa è FetchXML?

Answer 4

FetchXML

FetchXML è un robusto linguaggio di query che consente query complesse di dati Dataverse.

• Microsoft fornisce agli utenti un modo per eseguire query FetchXML all’interno di una query API Web.
• Questo approccio può essere utile se ti imbatti in uno scenario in cui FetchXML è più adatto per la tua query particolare rispetto all’utilizzo della sintassi della query OData.

Question 5

Authenticate against Microsoft Dataverse by using OAuth

Differenza tra Autenticazione e Autorizzazione?

Answer 5

Authentication vs. authorization

OAuth fornisce un meccanismo standardizzato del settore per l’autenticazione delle applicazioni client rispetto a una risorsa.

• Authentication : è il processo o l’azione di verifica dell’identità di un utente o di un processo.
  
  • ​La soluzione di Microsoft a questo processo di verifica è Azure Active Directory (Azure AD).
  • Azure AD supporta una serie di opzioni per verificare l’identità di un utente o di un processo.
    
    • Abstracting your identity provider allows for a good separation of concerns because managing usernames and passwords can be a difficult (and risky) process.
• Authorization : è il processo o l’azione per verificare se un utente autenticato è autorizzato ad accedere alle risorse fornite.
  
  • Attualmente, l’autorizzazione per Dataverse è a livello di tenant e le autorizzazioni sono delegate all’applicazione in base all’utente che ha eseguito l’accesso.
  • Pertanto, non utilizzerai OAuth per governare la sicurezza a livello di app, che viene invece gestita tramite l’interfaccia di amministrazione di Power Apps.

Question 6

Authenticate against Microsoft Dataverse by using OAuth

Come si registra una Dataverse App con Azure AD?

Answer 6

Register Dataverse apps with Azure AD

Per connettersi correttamente al tuo Dataverse, devi prima registrare un’app con Azure Active Directory, che può essere completata nel portale di Azure.

• A seconda del tipo di app che si desidera creare, sono disponibili alcune impostazioni diverse da configurare (app Web rispetto a app native installate in modo nativo su un dispositivo). Per ulteriori informazioni sulle impostazioni necessarie per ciascuno di questi tipi, vedere Tipi di registrazione dell’app.

Il seguente elenco riassume quando utilizzare i diversi tipi di account:

• Accounts in this organizational directory only (Single tenant)
  
  • ​Tutti gli account utente e ospite nella tua directory possono utilizzare la tua applicazione o API.
  • Usa questa opzione se il tuo target di destinazione è interno alla tua organizzazione
• ​Accounts in any organizational directory (Any Azure AD directory - Multitenant)
  
  • ​Tutti gli utenti con un account aziendale o dell’istituto di istruzione di Microsoft possono utilizzare la tua applicazione o API, comprese le scuole e le aziende che utilizzano Microsoft 365.
  • Utilizzare questa opzione se il target di destinazione è costituito da clienti aziendali o educativi e per abilitare il multi-tenancy.
• ​Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (for example, Skype and Xbox)
  
  • ​Tutti gli utenti con un account Microsoft aziendale, scolastico o personale possono utilizzare la tua applicazione o API.
  • Include scuole e aziende che utilizzano Microsoft 365 e account personali utilizzati per accedere a servizi come Xbox e Skype.

​Dovrai anche impostare alcuni flag su true nel manifest dell’app per consentire l’accesso da Postman e altre applicazioni esterne. Questo accesso viene concesso solo a scopo dimostrativo.

Question 7

Interact with Microsoft Dataverse Web API by using Postman

Cosa devi fare prima di usare postman per connetterti alla tua API?

Answer 7

Interact with Microsoft Dataverse Web API by using Postman

1) Per connettere Postman a Microsoft Dataverse, devi prima assicurarti di avere un’applicazione registrata nel tuo ambiente Azure AD.
2) Get the current version of your Web API endpoint

• Dalle Advanced settings, go to Settings > Customizations e poi vai alla pagina Developer Resources page.
  
  • Il numero di versione verrà indicato nella regione API Web dell’istanza es.(v9.1)

Question 8

Interact with Microsoft Dataverse Web API by using Postman

Come Impostare postman ?

Answer 8

Set up Postman

1. Launch the Postman desktop application.
2. Select the Environment Options gear icon in the top-right corner.
3. In the Manage Environments dialog box, select the Add button to add a new environment.
4. Nella finestra di dialogo che si apre, inserisci un nome per l’ambiente e poi aggiungi la seguente chiave
   • url : https://[ORGANIZATION].crm.dynamics.com
   • clientid:
   • version: 9.1
   • webapiurl: {{url}}/api/data/v{{version}}/
   • callback: https://callbackurl
   • authurl: https://login.microsoftonline.com/common/oauth2/authorize?resource={{url}}
5. Sostituisci il valore segnaposto dell’URL dell’istanza con l’URL della tua istanza di Dataverse, quindi seleziona Aggiungi per salvare l’ambiente.
6. Close the Manage environments dialog box.​

Question 9

Interact with Microsoft Dataverse Web API by using Postman

Come si crea un token su postman?

Answer 9

Generate an access token to use with your environment

connettersi utilizzando OAuth 2.0, è necessario disporre di un token di accesso. Per ottenere un nuovo token di accesso, segui questi passaggi:

1. Assicurati che il nuovo ambiente che hai creato sia selezionato.
2. Select the Authorization tab.
3. Set the Type to OAuth 2.0.
4. Verifica di aver selezionato l’ambiente che hai creato.
5. Select Get New Access Token.
6. Set the following values in the dialog box. Select Implicit from the Grant Type drop-down menu. You can set the Token Name to whatever you like and then leave other keys set to default values

Se si configurano ambienti in Postman per più istanze di Dataverse utilizzando credenziali utente diverse, potrebbe essere necessario eliminare i cookie memorizzati nella cache da Postman.

• Select the Cookies link, which can be found under the Send button, and remove the saved cookies from the Manage Cookies dialog box.
  7. Select Request Token. Quando si effettua questa selezione, viene visualizzata una pagina di accesso ad Azure Active Directory. Immettere il nome utente e la password.
  8. dopo che il token è stato generato, scorri fino in fondo e select Use token. Questa selezione chiude la finestra di dialogo Gestisci token di accesso.
  9. Dopo aver aggiunto un token, puoi selezionare quale token applicare alle richieste. Nell’elenco a discesa Token disponibili, seleziona il token appena creato. L’intestazione di autorizzazione verrà aggiunta alla richiesta API Web.

Question 10

Use FetchXML to query data

Come funzionano le fetchXML?

Answer 10

FetchXML Overview

FetchXML è un robusto linguaggio di query sviluppato da Microsoft per consentire l’esecuzione di operazioni complesse sui dati di Microsoft Dataverse. Fornisce molte più opzioni di filtro rispetto ai connettori OData e consente inoltre di visualizzare le etichette per i dati di riferimento come le etichette del set di opzioni oi campi di ricerca.

Puoi eseguire query FetchXML utilizzando i seguenti metodi:

• Dataverse Web API
• Organization Service

Question 11

Call Power Automate actions from the Web API

In che modo è possibile accedere al dataverse tramite Web API?

Answer 11

Call Power Automate actions from the Web API

Power Automate contiene una funzionalità che consente agli utenti esperti di creare i propri set of business logic called actions. Dal punto di vista dello sviluppatore, Microsoft Docs definisce un’action come “un’operazione riutilizzabile, che può avere effetti collaterali osservabili”.

• Questi effetti collaterali includono la creazione o l’aggiornamento di record o qualsiasi altra cosa che puoi ottenere utilizzando un flusso di lavoro classico di Microsoft Dataverse.
• Una caratteristica aggiuntiva delle action è la loro capacità di essere invocate tramite l’API Web.

Question 12

Call Power Automate actions from the Web API

Unbound vs. bound actions?

Answer 12

Unbound vs. bound actions

Dataverse viene fornito con una serie di action esistenti che puoi utilizzare per eseguire operazioni comuni. Alcune di queste action potrebbero essere applicate solo alle Model driven o Dynamics 365

Un’azione può essere costruita come non associata(UNBOUND) (nel senso che NON ha un’entità Dataverse correlata ad essa)

• gli sviluppatori SQL potrebbero considerare queste action come simili alle stored procedure (azioni non associate)
• rispetto ai trigger (azioni associate).

Le azioni non associate sono utili per la logica generica che potrebbe dover essere eseguita al di fuori del contesto di un record di entità specifica

Question 13

Use the Web API to impersonate another user

Come impersonare un altro utente tramite una chiamata Web API?

Answer 13

Implement a Web API request with user impersonation

Occasionalmente, potrebbe essere necessario eseguire la logica per un altro utente. Nel contesto di Microsoft Dataverse, la logica che stai eseguendo applicherà tutti i ruoli appropriati e la sicurezza basata sugli oggetti in base all’utente che stai impersonando.

• Questo metodo può essere particolarmente efficace quando si integrano sistemi esterni con una soluzione Dataverse in cui l’account di integrazione è un account di sistema rispetto all’utente che ha effettivamente richiamato la richiesta.

Quando si chiama un metodo API Web, è possibile fornire un CallerObjectId nell’intestazione del messaggio per indicare che si desidera che il messaggio venga eseguito per quel particolare utente.

• Il valore di questo parametro è l’ID oggetto di Azure Active Directory (Azure AD).
• L’API Graph di Azure fornisce un metodo per eseguire query sui dati utente di Azure AD.

Question 14

Track entity data changes with change tracking and the Web API

Cosa è il Change Tracking e come si abilita?

Answer 14

Di solito, le organizzazioni devono sincronizzare i dati su più sistemi. Microsoft Dataverse fornisce una funzionalità per gestire in modo efficiente questo scenario, chiamato change tracking.

• Con il change tracking. abilitato, puoi creare applicazioni per eseguire query per queste modifiche.
• È possibile abilitare il change tracking su un’entità impostando il flag Abilita rilevamento delle modifiche per il flusso nelle impostazioni dell’entità nel portale dei produttori di PowerApps, che si trova sotto il More settings > Create and update settings section.

Question 15

Track entity data changes with change tracking and the Web API

Cosa sono i Delta Link e che ruolo hanno nel change traking?

Answer 15

Delta links

Secondo la documentazione di OData 4.0, i delta links sono “link opachi generati dal servizio che il client utilizza per recuperare le modifiche successive a un risultato”.

Microsoft ha integrato questo standard nel rilevamento delle modifiche in Dataverse per fornire un metodo standard comune per l’interfacciamento con i dati delle modifiche man mano che si verificano nel tempo.

• Dopo aver emesso una richiesta di Change Tracking, la tua risposta conterrà un delta link, che passerai quindi alla tua richiesta successiva per ottenere le modifiche che si sono verificate dalla richiesta iniziale.
• Spetterà alla tua app mantenere il delta link, in modo simile a come avresti potuto eseguire il monitoraggio con la data