Treballar amb Customer Insights: API de dades

Dynamics 365 Customer Insights: les dades proporcionen API per crear les vostres pròpies aplicacions basades en les vostres dades al Customer Insights. Els detalls d'aquestes API es mostren a la referència de l'API. Inclouen informació addicional sobre operacions, paràmetres i respostes.

Nota

Customer Insights: també es pot accedir a les taules de dades mitjançant les API del Dataverse. Us recomanem que utilitzeu les API del Dataverse per consultar les dades del Customer Insights, ja que ofereixen un filtratge més ampli, un rendiment més gran i una latència més baixa. Per obtenir més informació, vegeu API del Dataverse per al Customer Insights.

Comenceu a provar les API

Un administrador ha d'habilitar l'accés de l'API a les vostres dades. Un cop habilitat l'accés, qualsevol usuari pot utilitzar l'API amb la clau de subscripció.

  1. Inicieu la sessió a Customer Insights: dades o registreu-vos per a una prova de Customer Insights.

  2. Aneu a Configuració>Permisos i seleccioneu la pestanya API.

  3. Si no s'ha configurat l'accés de l'API a l'entorn, seleccioneu Activa.

    L'habilitació de les API crea una clau de subscripció primària i secundària per al vostre entorn que s'utilitza a les sol·licituds d'API. Per tornar a generar les claus, seleccioneu Regenerar primària o Regenerar secundària a la pestanya API.

  4. Seleccioneu Explora les nostres API per provar-les.

  5. Cerqueu i seleccioneu una operació de l'API i seleccioneu Prova-la.

    Com provar les API.

  6. A la subfinestra lateral, definiu el valor del menú desplegable Autorització com a implícit. La Authorization capçalera s'afegeix amb una fitxa al portador. La clau de subscripció s'emplena automàticament.

  7. Opcionalment, afegiu tots els paràmetres de consulta necessaris.

  8. Desplaceu-vos fins a la part inferior de la subfinestra lateral i seleccioneu Envia.

    La resposta HTTP es mostra a la part inferior de la subfinestra

Crear un registre d'aplicació nou al portal de l'Azure

Creeu un registre d'aplicació nou per utilitzar les API d'una aplicació de l'Azure amb permisos delegats.

  1. Completeu la secció Introducció.

  2. Inicieu la sessió al portal de l'Azure amb el compte que pot accedir a les dades del Customer Insights.

  3. Cerqueu i seleccioneu Registres d'aplicacions.

  4. Seleccioneu Registre nou, proporcioneu un nom d'aplicació i trieu el tipus de compte.

    Opcionalment, afegiu un URL de redirecció. http://localhost és suficient per desenvolupar una aplicació a l'ordinador local.

  5. Seleccioneu Registra.

  6. En el registre nou de l'aplicació, aneu a Permisos de l'API.

  7. Seleccioneu Afegeix un permís i seleccioneu Dynamics 365 AI for Customer Insights a la subfinestra lateral.

  8. Per a Tipus de permís, seleccioneu Permisos delegats i, a continuació, seleccioneu el permís user_impersonation .

  9. Seleccioneu Afegeix permisos.

  10. Seleccioneu Concedeix el consentiment de l'administrador per... per completar el registre de l'aplicació.

  11. Per accedir a l'API sense que un usuari iniciï la sessió, aneu a Definir permisos d'aplicació de servidor a servidor.

Podeu utilitzar l'identificador d'aplicació/client per al registre d'aquesta aplicació amb la biblioteca d'autenticació de Microsoft (MSAL) per obtenir un testimoni de portador per enviar amb la vostra sol·licitud a l'API.

Per obtenir informació sobre l'ús de les API de les nostres biblioteques client, vegeu les biblioteques client del Customer Insights.

Definir permisos d'aplicació de servidor a servidor

Creeu un registre d'aplicació que no necessiti interacció de l'usuari i es pugui executar en un servidor.

  1. Al registre de l'aplicació al portal de l'Azure, aneu a Permisos de l'API.

  2. Seleccioneu Afegeix un permís.

  3. Seleccioneu la pestanya API que utilitza la meva organització i trieu Dynamics 365 AI for Customer Insights de la llista.

  4. Per a Tipus de permís, seleccioneu Permisos d'aplicació i, a continuació, seleccioneu el permís api.access .

  5. Seleccioneu Afegeix permisos.

  6. Torneu als permisos de l'API per al registre de l'aplicació.

  7. Seleccioneu Concedeix el consentiment de l'administrador per... per completar el registre de l'aplicació.

  8. Afegiu el nom del registre de l'aplicació com a usuari al Customer Insights - Dades.

    1. Obriu Customer Insights - Dades, aneu a Configuració>Permisos i seleccioneu Afegeix usuaris.

    2. Cerqueu el nom del registre de l'aplicació, seleccioneu-lo als resultats de la cerca i seleccioneu Desa.

Consultes d'exemple

Per obtenir una llista breu de consultes d'exemple d'OData per treballar amb les API, vegeu Exemples de consulta d'OData.

Biblioteques client del Customer Insights

Comenceu a utilitzar les biblioteques client disponibles per a les API de dades del Customer Insights. Tot el codi font de la biblioteca i les aplicacions d'exemple es poden trobar en un repositori de GitHub.

C# NuGet

Utilitzeu les biblioteques client de C# de NuGet.org. Actualment, el paquet s'adreça als marcs netstandard2.0 i netcoreapp2.0. Per obtenir més informació sobre el paquet NuGet, vegeu Microsoft.Dynamics.CustomerInsights.Api.

Afegir la biblioteca client de C# a un projecte de C#

  1. Al Visual Studio, obriu el Gestor de paquets NuGet del projecte.

  2. Cerqueu Microsoft.Dynamics.CustomerInsights.Api.

  3. Seleccioneu Instal·la per afegir el paquet al projecte.

    Com a alternativa, executeu aquesta ordre a la consola de l'Administrador de paquets NuGet: Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

Utilitzar la biblioteca client de C#

  1. Utilitzeu la biblioteca d'autenticació de Microsoft (MSAL) per obtenir un AccessToken ús del registre d'aplicacions de l'Azure existent.

  2. Després d'autenticar-se i adquirir correctament un testimoni, construïu-ne un de nou o utilitzeu-ne un d'existent HttpClient amb el DefaultRequestHeaders "Authorization" definit com a Bearer "token d'accés" i Ocp-Apim-Subscription-Key definit a la clau de subscripció del vostre entorn Customer Insights - Dades.

    Restableix la capçalera d'autorització quan sigui necessari. Per exemple, quan el testimoni ha caducat.

  3. Passar això HttpClient a la construcció del CustomerInsights client.

  4. Feu trucades amb el client als "mètodes d'extensió", per exemple, GetAllInstancesAsync. Si es prefereix l'accés al subjacent Microsoft.Rest.HttpOperationResponse , utilitzeu els "mètodes de missatge http", per exemple, GetAllInstancesWithHttpMessagesAsync.

  5. És probable que object la resposta sigui de tipus perquè el mètode pot retornar diversos tipus (per exemple, IList<InstanceInfo> i ApiErrorResult). Per comprovar el tipus de retorn, utilitzeu els objectes dels tipus de resposta especificats a la pàgina de detalls de l'API per a aquesta operació.

    Si necessiteu més informació sobre la sol·licitud, utilitzeu els mètodes de missatge http per accedir a l'objecte de resposta en brut.

Paquet NodeJS

Utilitzeu les biblioteques client de NodeJS disponibles a través de NPM: https://www.npmjs.com/package/@microsoft/customerinsights

Paquet Python

Utilitzeu les biblioteques client de Python disponibles a través de PyPi: https://pypi.org/project/customerinsights/

  • Last updated on