Utiliser Customer Insights - API de données

Dynamics 365 Customer Insights : les données fournissent des API pour créer vos propres applications en fonction de vos données dans Customer Insights. Les détails de ces API sont répertoriés sur la référence de l’API. Ils incluent des informations supplémentaires sur les opérations, les paramètres et les réponses.

Prise en main de l’essai des API

Un administrateur doit activer l’accès d’API à vos données. Une fois l’accès activé, n’importe quel utilisateur peut utiliser l’API avec la clé d’abonnement.

1. Connectez-vous à Customer Insights - Données ou inscrivez-vous à une version d’évaluation de Customer Insights.

2. Accédez à Autorisations des paramètres> et sélectionnez l’onglet API.

3. Si l’accès à l’API à l’environnement n’a pas été configuré, sélectionnez Activer.

   L’activation des API crée une clé d’abonnement primaire et secondaire pour votre environnement qui est utilisée dans les requêtes d’API. Pour régénérer les clés, sélectionnez le régénérer principal ou régénérer secondaire sous l’onglet API .

4. Sélectionnez Explorer nos API pour essayer les API.

5. Recherchez et sélectionnez une opération d’API, puis sélectionnez Essayer.

   

6. Dans le volet latéral, définissez la valeur dans le menu déroulant Autorisationsur implicite. L’en-tête Authorization est ajouté avec un jeton du porteur. Votre clé d’abonnement est automatiquement remplie.

7. Si vous le souhaitez, ajoutez tous les paramètres de requête nécessaires.

8. Faites défiler jusqu’au bas du volet latéral, puis sélectionnez Envoyer.

   La réponse HTTP s’affiche en bas du volet.

Créer une inscription d’application dans le portail Azure

Créez une inscription d’application pour utiliser les API dans une application Azure à l’aide d’autorisations déléguées.

1. Terminez la section Prise en main.

2. Connectez-vous au portail Azure avec le compte qui peut accéder aux données Customer Insights.

3. Recherchez, puis sélectionnez Inscriptions d’applications.

4. Sélectionnez Nouvelle inscription, fournissez un nom d’application et choisissez le type de compte.

   Si vous le souhaitez, ajoutez une URL de redirection. http://localhost est suffisant pour développer une application sur votre ordinateur local.

5. Sélectionnez Inscription.

6. Sur votre nouvelle inscription d’application, accédez aux autorisations d’API.

7. Sélectionnez Ajouter une autorisation et sélectionnez Dynamics 365 AI for Customer Insights dans le volet latéral.

8. Pour le type d’autorisation, sélectionnez Autorisations déléguées , puis sélectionnez l’autorisation user_impersonation .

9. Sélectionnez Ajouter des autorisations.

10. Sélectionnez Accorder le consentement de l’administrateur pour... pour terminer l’inscription de l’application.

11. Pour accéder à l’API sans connexion utilisateur, accédez à Définir des autorisations d’application serveur à serveur.

Vous pouvez utiliser l’ID d’application/client pour cette inscription d’application auprès de la bibliothèque d’authentification Microsoft (MSAL) pour obtenir un jeton du porteur à envoyer avec votre demande à l’API.

Pour plus d’informations sur l’utilisation des API dans nos bibliothèques clientes, consultez les bibliothèques clientes Customer Insights.

Définir les autorisations d’application serveur à serveur

Créez une inscription d’application qui n’a pas besoin d’interaction utilisateur et qui peut être exécutée sur un serveur.

1. Sur votre inscription d’application dans le portail Azure, accédez aux autorisations d’API.

2. Sélectionnez Ajouter une autorisation.

3. Sélectionnez les API que mon organisation utilise l’onglet et choisissez Dynamics 365 AI for Customer Insights dans la liste.

4. Pour le type d’autorisation, sélectionnez Autorisations d’application , puis sélectionnez l’autorisation api.access .

5. Sélectionnez Ajouter des autorisations.

6. Revenez aux autorisations d’API pour l’inscription de votre application.

7. Sélectionnez Accorder le consentement de l’administrateur pour... pour terminer l’inscription de l’application.

8. Ajoutez le nom de l’inscription de l’application en tant qu’utilisateur dans Customer Insights - Données.

   1. Ouvrez Customer Insights - Données, accédez auxautorisations des>, puis sélectionnez Ajouter des utilisateurs.

   2. Recherchez le nom de votre inscription d’application, sélectionnez-le dans les résultats de la recherche, puis sélectionnez Enregistrer.

Exemples de requêtes

Pour obtenir une courte liste des exemples de requêtes OData à utiliser avec les API, consultez les exemples de requêtes OData.

Bibliothèques clientes Customer Insights

Commencez à utiliser les bibliothèques clientes disponibles pour les API Customer Insights - Données. Vous trouverez tout le code source de la bibliothèque et les exemples d’applications sur un dépôt GitHub.

C# NuGet

Utilisez les bibliothèques clientes C# de NuGet.org. Actuellement, le package cible les frameworks netstandard2.0 et netcoreapp2.0. Pour plus d’informations sur le package NuGet, consultez Microsoft.Dynamics.CustomerInsights.Api.

Ajouter la bibliothèque de client C# à un projet C#

1. Dans Visual Studio, ouvrez le Gestionnaire de package NuGet pour votre projet.

2. Recherchez Microsoft.Dynamics.CustomerInsights.Api.

3. Sélectionnez Installer pour ajouter le package au projet.

   Vous pouvez également exécuter cette commande dans la console du Gestionnaire de package NuGet : Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

Utiliser la bibliothèque de client C#

1. Utilisez la bibliothèque d’authentification Microsoft (MSAL) pour obtenir une AccessTokeninscription d’application Azure existante.

2. Après l’authentification et l’acquisition d’un jeton, construisez un nouveau ou utilisez un existant HttpClient avec defaultRequestHeaders « Authorization » défini sur Bearer « access token » et Ocp-Apim-Subscription-Key défini sur la clé d’abonnement de votre environnement Customer Insights - Data.

   Réinitialisez l’en-tête d’autorisation le cas échéant. Par exemple, lorsque le jeton a expiré.

3. Passez-le HttpClient dans la construction du CustomerInsights client.

4. Effectuez des appels avec le client aux « méthodes d’extension », par exemple GetAllInstancesAsync. Si l’accès au sous-jacent Microsoft.Rest.HttpOperationResponse est préféré, utilisez les « méthodes de message http », par exemple GetAllInstancesWithHttpMessagesAsync.

5. La réponse est probablement object de type, car la méthode peut retourner plusieurs types (par exemple, IList<InstanceInfo> et ApiErrorResult). Pour vérifier le type de retour, utilisez les objets dans les types de réponse spécifiés dans la page de détails de l’API pour cette opération.

   Si des informations supplémentaires sur la demande sont nécessaires, utilisez les méthodes de message HTTP pour accéder à l’objet de réponse brute.

Package NodeJS

Utilisez les bibliothèques clientes NodeJS disponibles via NPM : https://www.npmjs.com/package/@microsoft/customerinsights

Paquet Python

Utilisez les bibliothèques clientes Python disponibles via PyPi : https://pypi.org/project/customerinsights/