Partager via

Utilisez l’API Web Microsoft Dataverse

Vous pouvez utiliser l’API web ou le SDK pour .NET pour travailler avec des données, ainsi que des définitions de table et de colonne dans Dataverse.

L’API Web Dataverse fournit une expérience de développement pouvant être utilisée avec une grande variété de langues, de plateformes et d’appareils. API web met en œuvre OData (protocole Open Data), la version 4.0, une norme d’OASIS pour générer et consommer des API RESTful sur des sources de données multiples. Pour en savoir plus sur ce protocole : https://www.odata.org/. Les détails sur cette norme OASIS sont disponibles à l’adresse https://www.oasis-open.org/standards#odatav4.0.

Comme l’API web repose sur des normes ouvertes, nous ne fournissons pas les assemblys pour une expérience développeur spécifique. Vous pouvez composer des requêtes HTTP pour des opérations spécifiques ou utiliser des bibliothèques tierces pour générer la langue ou la plateforme de votre choix. Vous trouverez une liste des bibliothèques prenant en charge OData version 4.0 à l’adresse suivante : https://www.odata.org/libraries/.

API Web et service Organisation

Il est utile de reconnaître que le service d’organisation est ce qui définit la plateforme. L’API Web offre une expérience de programmation RESTful, mais au final, toutes les opérations de données passent par le service Oorganisation sous-jacent. Le service Organisation définit les opérations prises en charge sous forme de messages. Chaque message a un nom. Ces noms sont liés aux événements utilisés dans la structure d’événements pour évaluer quelles extensions enregistrées doivent être lancées. Informations complémentaires : Infrastructure d’événements

L’API web vous permet d’effectuer exactement les mêmes opérations que le SDK pour .NET, mais les présente dans un style RESTful. OData v4 fournit des opérations nommées fonctions ou actions. La plupart des messages disponibles dans le service d’organisation sont exposés en tant que fonction ou action nommée correspondante. Ces messages correspondant aux opérations CRUD ne sont pas disponibles dans l’API web car, en tant que service RESTful, ils ont des implémentations à l’aide des méthodes HTTP GET, POST, PATCH et DELETE, mais dans la plateforme, les messages récupérer, créer, mettre à jour et supprimer sont appelés de la même manière que les opérations correspondantes sont effectuées à l’aide des assemblys du SDK pour .NET.

Démarrage

Vous pouvez utiliser l’API web dans n’importe quelle langue qui vous permet d’envoyer des requêtes HTTP authentifiées. Nous avons préparé quelques expériences de démarrage pour quatre scénarios courants :

Outils de requête HTTP

Une application qui vous permet de composer et d’envoyer des requêtes HTTP authentifiées est une première étape essentielle. Il en existe beaucoup, par exemple Postman, Bruno ou curl. Choisissez et utilisez ce que vous préférez. Nous fournissons quelques étapes pour utiliser Insomnia car il dispose d’une interface utilisateur graphique, d’une installation relativement facile et offre la possibilité de refuser de créer un compte. Découvrez comment utiliser Insomnia avec l’API web Dataverse

Astuce

À moins que vous n’ayez déjà un outil de requête HTTP favori, vous constaterez peut-être que l’utilisation de PowerShell avec Visual Studio Code facilite le démarrage et offre également de puissantes capacités de script.

Développeurs PowerShell

L’utilisation de l’API Web avec PowerShell est l’un des moyens les plus simples de démarrer. Vous pouvez utiliser l’applet de commande Invoke-RestMethod pour envoyer des demandes et traiter les réponses à l’aide de l’applet de commande ConvertTo-Json.

Vous pouvez trouver le contenu suivant sur l’utilisation de PowerShell avec l’API Web :

Développeurs JavaScript

Les développeurs JavaScript utilisent fréquemment l’API web Dataverse avec des applications pilotées par modèle. Les applications pilotées par modèle fournissent l’objet Xrm.WebApi qui expose les méthodes pour interagir avec l’API web. En savoir plus sur Javascript côté client avec l’API web dans les applications pilotées par modèle.

Les applications à une seule page (SPA) utilisent également JavaScript et peuvent se connecter à l’API web Dataverse. Démarrage rapide : API web avec JavaScript côté client et Visual Studio Code décrit comment se connecter à l’API web en utilisant un modèle d’application SPA. Vous trouverez d’autres exemples dans la section Exemples d’opérations de données de l’API web (JavaScript côté client).

Dans les composants Power Apps Component Framework (PCF), les développeurs JavaScript utilisent des méthodes qui font partie de l’objet WebAPI pour utiliser des données Dataverse dans les composants PCF.

Enfin, Power Pages expose une API web des portails qui offre un sous-ensemble d’opérations Dataverse disponibles à l’aide de l’API web.

Développeurs .NET

Les développeurs .NET peuvent utiliser le SDK Dataverse pour .NET ou l’API web. Vous souhaiterez peut-être utiliser l’API web lorsque vous ne souhaitez pas dépendre d’un package NuGet spécifique ou lorsque les exigences de votre projet ne nécessitent pas les classes fortement typées fournies par le SDK pour .NET.

Pour utiliser l’API web avec C#, consultez ces articles de démarrage rapide :

Il existe de nombreux autres exemples d’API web C# dans la section Exemples d’opérations de données de l’API web (C#)

Utiliser des données à l’aide de code
OData - the best way to REST
Partie 1 de la version 4.0 d’OData : Protocol Plus Errata 02
Partie 2 de la version 4.0 d’OData : Conventions URL Plus Errata 02
Partie 3 de la version 4.0 d’OData : Langage CSDL (Conceptual Schema Definition Language) Plus Errata 02