Types et opérations d’API web

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

Comme 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 que vous devez faire consiste à examiner les documents de service d’un environnement Dataverse auquel vous pouvez accéder. Pour cela, vous devez 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 pour afficher les documents de service.

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

Utilisez les instructions dans Afficher les ressources du développeur pour identifier un point de terminaison d’API web pour un environnement auquel vous pouvez accéder. Il doit ressembler à ceci : https://yourorg.api.crm.dynamics.com/api/data/v9.2.

S’authentifier auprès du service

Vous pouvez vous authentifier de plusieurs façons pour interagir avec le service. L’insomnie est un choix populaire avec une adoption large. Vous pouvez également utiliser PowerShell avec Visual Studio Code.

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

Configurer un environnement d’insomnie

Le client d’API Insomnie offre un excellent moyen de se connecter à vos environnements et d’explorer l’API Web Dataverse. L’insomnie peut simplifier considérablement la gestion de l’obtention d’un jeton d’accès lors de l’utilisation de l’API Web Dataverse.

Utilisez les étapes dans Utiliser Insomnia avec l’API Web Dataverse

Utiliser PowerShell avec Visual Studio Code

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

OData v4.0 standard

Les articles de cette section résument les informations pertinentes pour l’implémentation de l’API Web Dataverse de la norme OData v4.0. Un service qui implémente OData doit respecter les normes définies dans la spécification, mais n’est pas nécessaire pour implémenter toutes les parties de la spécification.

Pour plus d’informations, consultez les documents suivants :

• OData version 4.0. Partie 1 : Protocole Plus Errata 03
• OData version 4.0. Partie 2 : Conventions d’URL plus Errata 03
• OData version 4.0. Partie 3 : Langage de définition de schéma commun et Errata 03
• Version 4.0 du format JSON OData

Étapes suivantes

Découvrez les documents du service d’API web.

Service Documents

Voir aussi

Documents de service d’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 d’API web
Types complexes et énumération de l’API web
Utiliser l’API web Dataverse
S’authentifier auprès de Dataverse avec l’API web
Effectuer des opérations à l’aide de l’API Web