Traballar con API de Customer Insights - Data

Nota

As APIs de Customer Insights serán desaprobadas o 31 de agosto de 2024. Customer Insights recomenda que use Dataverse APIs para consultar os datos de Customer Insights. Para máis información, consulte Dataverse APIs para Customer Insights.

Dynamics 365 Customer Insights - Data ofrece API para construír as súas propias aplicacións en función dos seus datos en Customer Insights. Os detalles destas APIs están listados na referencia da API. Inclúen información adicional sobre operacións, parámetros e respostas.

Comece a probar as APIs

Un administrador debe permitir o acceso da API aos seus datos. Unha vez habilitado o acceso, calquera usuario pode utilizar a API coa clave de subscrición.

  1. Inicia sesión Customer Insights - Data ou rexístrate nunha versión de proba de Customer Insights.

  2. Vai a Configuración Permisos e selecciona a> pestana APIs .

  3. Se non se configurou o acceso da API ao medio ambiente, seleccione Activar.

    Habilitar as API crea unha clave de subscrición primaria e secundaria para a súa contorna que se usa nas solicitudes da API. Para rexenerar as teclas, seleccione a primaria rexenerada ou Rexenera secundaria na pestana APIs .

  4. Seleccione Explore as nosas APIs para probar as APIs .

  5. Busca e selecciona unha operación da API e selecciona Probala.

    Como probar as APIs.

  6. No panel lateral, establece o valor no menú despregable de autorización para implícito. A Authorization cabeceira engádese cun token portador. A clave de subscrición está poboada automaticamente.

  7. Opcionalmente, engada todos os parámetros de consulta necesarios.

  8. Desprácese ata a parte inferior do panel lateral e selecciona Enviar.

    A resposta HTTP móstrase na parte inferior do panel.

Crear un novo rexistro de aplicacións no portal de Azure

Cree un novo rexistro de aplicacións para usar as API nunha aplicación Azure usando permisos delegados.

  1. Completa a sección Introdución.

  2. Inicia sesión no portal Azure coa conta que pode acceder aos datos de Customer Insights.

  3. Busca e, a seguir, selecciona Rexistros de aplicacións.

  4. Seleccione Novo rexistro, proporcione un nome da aplicación e escolla o tipo de conta.

    Opcionalmente, engada un URL de redireccionamento. http://localhost é suficiente para desenvolver unha aplicación no seu ordenador local.

  5. Seleccione Rexistrar.

  6. No seu novo rexistro de App, vai aos permisos daAPI.

  7. Seleccione Engadir un permiso e seleccione Dynamics 365 AI para Customer Insights no panel lateral.

  8. Para o tipo de permiso, selecciona Permisos delegados e, a seguir, selecciona o permiso user_impersonation .

  9. Seleccione Engadir permisos.

  10. Seleccione o consentimento do administrador de Grant para... Para completar o rexistro da app.

  11. Para acceder á API sen que un usuario inicie sesión, vai a Set permisos de aplicación servidor aservidor.

Podes usar o ID de aplicación/cliente para este rexistro de aplicacións coa Microsoft Authentication Library (MSAL) para obter un símbolo portador para enviar coa súa solicitude á API.

Para obter información sobre o uso das API nas nosas bibliotecas de clientes, consulte Customer Insights client libraries.

Configurar permisos de aplicación servidor a servidor

Cree un rexistro de aplicacións que non necesite interacción co usuario e que se poida executar nun servidor.

  1. No seu rexistro de App no portal Azure, vai aos permisos da API.

  2. Seleccione Engadir un permiso.

  3. Seleccione as APIs que a miña organización usa a pestana e escolla Dynamics 365 AI para Customer Insights da lista.

  4. Para tipo de permiso, selecciona Permisos de aplicación e, a seguir, selecciona o permiso deapi.access .

  5. Seleccione Engadir permisos.

  6. Volve aos permisos da API para o rexistro da aplicación.

  7. Seleccione o consentimento do administrador de Grant para... Para completar o rexistro da app.

  8. Engade o nome do rexistro da app como usuario Customer Insights - Data.

    1. Abre Customer Insights - Data, vai a Configuración permisos> e selecciona Engadir usuarios.

    2. Busca o nome do rexistro da aplicación, selecciónao dos resultados da busca e selecciona Gardar.

Consultas de mostra

Para unha breve lista de consultas de mostra OData para traballar coas APIs, consulte exemplos de consulta OData.

Bibliotecas de clientes de Customer Insights

Comece a usar as bibliotecas de clientes dispoñibles para as Customer Insights - Data API. Todo o código fonte da biblioteca e as aplicacións de mostra pódense atopar nun repo de GitHub.

C# NuGet

Use as bibliotecas de clientes C# desde.org NuGet. Actualmente, o paquete ten como obxectivo os frameworks netstandard2.0 e netcoreapp2.0. Para máis información sobre o NuGet paquete, consulte Microsoft.Dynamics.CustomerInsights.Api.

Engadir a biblioteca de clientes de C# a un proxecto de C#

  1. En Visual Studio, abre o Xestor NuGet de paquetes para o seu proxecto.

  2. Busca Microsoft.Dynamics.CustomerInsights.Api.

  3. Seleccione Instalar para engadir o paquete ao proxecto.

    Alternativamente, execute este comando na Consola NuGet xestor depaquetes: Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

Usar a biblioteca de clientes de C#

  1. Usa a Microsoft Authentication Library (MSAL) para obter un AccessToken uso do seu rexistro de aplicacións Azure existente.

  2. Despois de autenticar e adquirir un token con éxito, construír unha nova ou usar un existente HttpClient cos DefaultRequestHeaders "Autorización" establecido para Bearer "access token" e Ocp-Apim-Subscription-Key set á clave de subscrición da súa Customer Insights - Data contorna.

    Restablecer a cabeceira de autorización cando proceda. Por exemplo, cando o token caducou.

  3. Pasa isto HttpClient á construción do CustomerInsights cliente.

  4. Fai chamadas co cliente aos "métodos de extensión", por exemplo. GetAllInstancesAsync Se se prefire o acceso ao subxacente Microsoft.Rest.HttpOperationResponse , use os "métodos de mensaxe http", por exemplo, GetAllInstancesWithHttpMessagesAsync.

  5. É probable que a resposta sexa de object tipo porque o método pode devolver varios tipos (por exemplo, IList<InstanceInfo> e ApiErrorResult). Para comprobar o tipo de devolución, use os obxectos dos tipos de resposta especificados na páxina de detalles da API para esa operación.

    Se se necesita máis información sobre a solicitude, utilice os métodos de mensaxe http para acceder ao obxecto de resposta en bruto.

Paquete NodeJS

Use as bibliotecas de clientes NodeJS dispoñibles a través de NPM: https://www.npmjs.com/package/@microsoft/customerinsights

Paquete Python

Use as bibliotecas de clientes Python dispoñibles a través de PyPi: https://pypi.org/project/customerinsights/