Présentation de l’API web Microsoft Dataverse
API web et service Organization
L’API web et le service Organization sont les deux méthodes principales permettant d’interagir avec les données et les métadonnées dans Microsoft Dataverse. Vous pouvez utiliser le service Organization lors de l’écriture de plug-ins ou d’extensions de flux de travail à l’aide du kit de développement logiciel (SDK) .NET que Microsoft fournit.
Quelle que soit votre approche, toutes les opérations de données passent par le service d’organisation sous-jacent. Ainsi, l’API web vous permet d’effectuer les mêmes opérations que le service Organization, mais dans un style RESTful.
Le graphique suivant représente un arbre de décision vous permettant de déterminer quand utiliser l’API web ou le service Organization (au moyen des assemblys SDK disponibles dans le package NuGet Microsoft.CrmSdk.CoreAssemblies). Il indique également quand utiliser les assemblys Dataverse ServiceClient (disponibles dans le package NuGet Microsoft.PowerPlatform.Dataverse.Client) pour les applications Windows.
Ce module porte sur l’API web. Pour en savoir plus sur le service Organization, consultez Utiliser le service Dataverse Organization dans le guide du développeur Dataverse.
OData (Open Data Protocol) 4.0
L’API web Dataverse est implémentée en tant que service OData (OASIS Open Data Protocol). L’utilisation d’une telle norme sectorielle procure tous les avantages du développement de normes ouvertes, comme la compatibilité multiplateforme et l’implémentation simple par rapport à un protocole prédéfini commun.
Dataverse ne fournit pas d’outils .NET spécifiques pour l’API web. À la place, nous vous recommandons d’utiliser des bibliothèques communautaires conformes au protocole OData. Si vous souhaitez en savoir plus sur les bibliothèques existantes, consultez https://www.odata.org/libraries/.
OData vous permet d’interagir avec des données Dataverse avec des opérations CRUD (création, lecture, mise à jour et suppression) disponibles au moyen des méthodes HTTP standard GET, POST, PATCH et DELETE. (Vous pourrez en savoir plus sur ces méthodes ultérieurement dans ce module.) Vous pouvez également effectuer la quasi-totalité des autres opérations exposées par l’Infrastructure d’événements Dataverse en invoquant une fonction ou action OData portant le même nom que son message de service Organization correspondant. Les messages liés aux actions CRUD sont les seuls qui ne sont pas disponibles, car ils utilisent les méthodes HTTP standard décrites précédemment.
REST
En substance, le protocole OData est un ensemble d’API RESTful (transfert d’état représentatif), une norme sectorielle permettant d’assurer l’interopérabilité entre les systèmes. REST se compose de six principes directeurs qui restreignent la façon dont un service peut traiter et répondre aux demandes afin de garantir que les propriétés non fonctionnelles de ce service sont respectées (telles que les performances, l’évolutivité, la simplicité, la fiabilité, etc.).
Pour les besoins de cette leçon, vous devez garder à l’esprit qu’OData est conforme à ces contraintes et que l’API web Dataverse implémentant le protocole OData est également conforme aux contraintes.
FetchXML
FetchXML est un langage de requête robuste qui permet d’exécuter des requêtes complexes de données Dataverse. FetchXML vous permet de composer vos critères de requête lorsque vous exécutez des requêtes avec l’API web Dataverse. Cette approche peut être utile si vous rencontrez un scénario où FetchXML est mieux adapté à votre requête spécifique que la syntaxe de requête OData. Vous pourrez en savoir plus sur FetchXML dans une unité ultérieure de ce module.