Types d’API web et opérations

Les articles de cette zone vous aideront à comprendre l’API web Dataverse en introduisant des concepts importants et en vous montrant comment obtenir les informations dont vous aurez besoin en comprenant les documents de service.

À l’instar de l’API Microsoft Graph, l’API web Dataverse est un service OData RESTful. Contrairement à l’API Microsoft Graph, chaque environnement a une URL d’organisation différente et inclut des tables et des opérations personnalisées qui peuvent être uniques à chaque environnement. Chaque environnement est différent en raison de l’ensemble unique de personnalisations ou de solutions installées.

Premières étapes

La première chose à faire consiste à consulter les documents de service pour un environnement Dataverse auquel vous pouvez accéder. Pour cela, vous aurez besoin de connaître l’URL de votre environnement. Ensuite, nous vous recommandons de configurer certaines façons de gérer l’authentification auprès du service afin d’afficher les documents de service.

Rechercher l’URL du point de terminaison de l’API web

Utilisez les instructions dans Afficher les ressources pour les développeurs pour identifier un point de terminaison d’API web pour un environnement auquel vous pouvez accéder. La syntaxe devrait être similaire à ceci : https://yourorg.api.crm.dynamics.com/api/data/v9.2.

S’authentifier au service

Il existe plusieurs façons de vous authentifier pour interagir avec le service. Insomnia est un choix populaire et largement adopté. Vous pouvez également utiliser PowerShell avec Visual Studio Code.

Vous pouvez utiliser une méthode pour récupérer les documents de service et voir des exemples montrant comment les informations des articles de cette section s’appliquent à votre environnement. Vous pouvez également effectuer tout autre type d’opération pour essayer les fonctionnalités de l’API web.

Configurer un environnement Insomnia

Le client API Insomnia fournit un excellent moyen de vous connecter à vos environnements et d’explorer l’API web Dataverse. Insomnia peut grandement simplifier la gestion et l’obtention d’un jeton d’accès lors de l’utilisation de l’API web Dataverse.

Suivez les étapes dans Utiliser Insomnia avec l’API web Dataverse

Utiliser PowerShell avec Visual Studio Code

Suivez les étapes décrites dans Démarrage rapide : API web avec PowerShell et Visual Studio Code pour vous authentifier auprès du service. Utiliser PowerShell et Visual Studio Code avec l’API web Dataverse développe le démarrage rapide pour décrire les façons avancées d’interagir avec l’API web Dataverse. La section Télécharger le document $metadata CSDL de l’API web Dataverse contient un script pour télécharger le document $metadata CSDL.

Standard OData v4.0

Les articles de cette section résument les informations pertinentes pour la mise en œuvre de l’API web Dataverse du standard OData v4.0. Un service qui implémente OData doit suivre les standards définies dans la spécification, mais n’est pas tenu d’implémenter toutes les parties de la spécification.

Pour plus d’informations, voir les documents suivants :

• Partie 1 de la version 4.0 d’OData : Protocol Plus Errata 03
• Partie 2 de la version 4.0 d’OData : Conventions URL Plus Errata 03
• Partie 3 de la version 4.0 d’OData : Langage CSDL (Conceptual Schema Definition Language) Plus Errata 03
• Format JSON OData Version 4.0

Étapes suivantes

Découvrez les documents relatifs au service de l’API web.

Voir aussi

Documents de service de l’API web
EntityTypes de l’API web
Propriétés de l’API web
Propriétés de navigation de l’API web
Actions de l’API web
Fonctions de l’API web
Types Complex et Enumeration de l’API web
Utilisation de l’API web Dataverse
Authentification Dataverse avec l’API web
Effectuer des opérations à l’aide de l’API web