Démarrer un projet de l’API Web Microsoft Dataverse dans Visual Studio (C#)

Article
03/10/2022
2 minutes de lecture

Cette rubrique montre comment créer un nouveau projet dans Visual Studio 2017 (ou une version ultérieure) qui crée une application de console utilisant l’API Web Dataverse. Elle illustre les références communes et les ressources de projet que la plupart des applications, notamment les exemples en C# du Kit de développement logiciel (SDK), utilisent pour implémenter des solutions basées sur l’API Web.

Configuration requise

Les conditions préalables suivantes sont requises pour générer l’application console décrite dans cette section.

Visual Studio 2017 installé sur votre ordinateur de développement. Toute édition, notamment Visual Studio Express, devrait être suffisante pour utiliser l’API Web Dataverse.
Un client NuGet doit être installé : l’utilitaire de ligne de commande ou l’extension Visual Studio. Pour plus d’informations, voir Installation de NuGet.

Créer un projet

La procédure suivante explique comment créer un projet d’application console en C# qui utilise le Microsoft .NET Framework.

Nouveau projet

Dans Visual Studio, cliquez sur Nouveau projet. La boîte de dialogue Nouveau projet s’affiche.
Dans le volet de navigation de gauche, sous Modèles, sélectionnez Visual C#.
Au-dessus de la liste des modèles disponibles, sélectionnez .NET Framework 4.6.2.
Dans la liste des modèles, sélectionnez Application de console (.NET Framework). (Sinon, sélectionnez le type de projet adapté à votre solution.) Tous les exemples d’API Web C# sont des applications de console.
Dans les zones de texte en bas du formulaire, indiquez le nom et l’emplacement du projet, puis sélectionnez OK. (Pour cette rubrique, on utilise la solution nommée « StartWebAPI-CS ».) Les fichiers d’origine de la solution seront générés et la solution sera chargée dans Visual Studio.
Dans le menu Projet, ouvrez le formulaire des propriétés du projet et vérifiez que l’infrastructure cible a la valeur NET Framework 4.6.2.

Installer et vérifier les références d’assembly requises

Une fois que le projet s’ouvre, cliquez sur Outils dans la barre de contrôle dans la partie supérieure de votre projet. Sélectionnez Gestionnaire de packages NuGet > console Gestionnaire de packages et installez les packages NuGet suivants.

install-package Newtonsoft.Json
install-package System.Net.Http

Dans l’Explorateur de solutions, développez le nœud Références.
Confirmez que toutes les références requises ont été ajoutées au projet.
Si vous utilisez régulièrement des fonctionnalités supplémentaires dans vos applications, vous pouvez ajouter les références associées aux assemblys requis. Pour plus d’informations, voir Procédure d’ajout ou de suppression de références à l’aide de la boîte de dialogue Ajouter une référence.

Comme l’API Web de Dataverse est basée sur les principes REST, elle ne requiert pas l’accès aux assemblys côté client. Toutefois, d’autres API prises en charge par les applications Dataverse les nécessitent.

Ajouter des instructions using classiques

Dans l’Explorateur de solutions, ouvrez Program.cs pour modification.
En haut du fichier, ajoutez les instructions using suivantes, qui font référence aux espaces de noms couramment utilisés dans les solutions basées sur l’API Web de Dataverse.
```
using Newtonsoft.Json;  
using Newtonsoft.Json.Linq;  
using System.Net.Http;  
using System.Net.Http.Headers;
```
Si vous avez ajouté des assemblys ou références régulièrement utilisés dans les sections précédentes, vous pouvez également ajouter des instructions using correspondantes pour ces ressources.
Enregistrez le fichier.

Ajouter un code de connexion

Cette section explique comment ajouter un ensemble de base de paramètres et d’instructions pour exécuter ces opérations.

Modifier le fichier de configuration de l’application

Dans l’Explorateur de solutions, ouvrez le fichier App.config pour modification. Ajoutez-lui les deux sections suivantes, après la section <startup> existante, puis enregistrez le fichier.


<connectionStrings>  
    <clear />  

    <!-- When providing a password, make sure to set the app.config file's security so that only you can read it. -->  
    <add name="default"   connectionString="Url=https://myserver/myorg/; Username=name; Password=password; Domain=domain" />  
    <add name="CrmOnline" connectionString="Url=https://mydomain.crm.dynamics.com/; Username=someone@mydomain.onmicrosoft.com; Password=password" />  
  </connectionStrings>  

  <appSettings>  
    <!--For information on how to register an app and obtain the ClientId and RedirectUrl  
        values see https://msdn.microsoft.com/dynamics/crm/mt149065 -->  
    <!--Active Directory application registration. -->  
    <!--These are dummy values and should be replaced with your actual app registration values.-->  
    <add key="ClientId" value="e5cf0024-a66a-4f16-85ce-99ba97a24bb2" />  
    <add key="RedirectUrl" value="https://localhost/SdkSample" />  

    <!-- Use an alternate configuration file for connection string and setting values. This optional setting  
    enables use of an app.config file shared among multiple applications. If the specified file does  
    not exist, this setting is ignored.-->  
    <add key="AlternateConfig" value="C:\Temp\crmsample.exe.config"/>  
  </appSettings>

Lors du développement ou du déploiement d’une solution, les valeurs de connexion et d’enregistrement de l’application réelles doivent être remplacées par les exemples de valeurs d’espace réservé.

Étapes suivantes

À ce stade, la solution peut être générée sans erreurs. Si vous modifiez le fichier de configuration de l’application pour fournir des valeurs pour Dynamics 365 Server, le programme doit également se connecter à ce serveur. La solution représente une structure qui est prête à accepter du code personnalisé, notamment des appels à l’API Web de Dataverse.

Conseil

Avant de quitter cette rubrique, pensez à enregistrer votre projet comme modèle de projet. Vous pouvez ensuite réutiliser ce modèle pour de futurs projets de formation et économiser ainsi du temps et des efforts lors de la configuration de nouveaux projets. Pour cela, tandis que votre projet est ouvert dans Microsoft Visual Studio, dans le menu Fichier sélectionnez Exporter le modèle. Suivez les instructions de l’Assistant Exporter le modèle pour créer le modèle.

Voir aussi

Se familiariser avec l’API Web (C#)
Utiliser la bibliothèque d’aide de l’API Web (C#)
Effectuer des opérations à l’aide de l’API web

Notes

Pouvez-vous nous indiquer vos préférences de langue pour la documentation ? Répondez à un court questionnaire. (veuillez noter que ce questionnaire est en anglais)

Le questionnaire vous prendra environ sept minutes. Aucune donnée personnelle n’est collectée (déclaration de confidentialité).