Работа с API на Customer Insights - Data

Dynamics 365 Customer Insights - Data предоставя API за изграждане на собствени приложения въз основа на вашите данни в Customer Insights. Подробности за тези API са изброени в препратката към API. Те включват допълнителна информация за операции, параметри и отговори.

Започнете да изпробвате API

Администраторът трябва да разреши API достъп до вашите данни. След като достъпът е разрешен, всеки потребител може да използва API с абонаментния ключ.

1. влезте в Customer Insights - Data или се регистрирайте за пробна версия на Customer Insights.

2. Отидете в Настройки>Разрешения и изберете раздела API .

3. Ако API достъпът до средата не е настроен, изберете Разреши.

   Активирането на API създава първичен и вторичен абонаментен ключ за вашата среда, който се използва в заявките за API. За да регенерирате ключовете, изберете Regenerate primary или Regenerate secondary в раздела API .

4. Изберете Разгледайте нашите API, за да изпробвате API.

5. Потърсете и изберете операция за API и изберете Опитай.

   

6. В страничния екран задайте стойността в падащото меню Упълномощаване на неявна. Заглавката Authorization се добавя с маркер на приносител. Вашият абонаментен ключ се попълва автоматично.

7. По желание добавете всички необходими параметри на заявката.

8. Превъртете до долната част на страничния екран и изберете Изпрати.

   HTTP отговорът се показва в долната част на екрана.

Създайте нова регистрация на приложение в портала на Azure

Създайте нова регистрация на приложение, за да използвате API в приложение на Azure, като използвате делегирани разрешения.

1. Попълнете раздела Първи стъпки.

2. влезте в портала на Azure с акаунта, който има достъп до данните на Customer Insights.

3. Потърсете и след това изберете Регистрации на приложения.

4. Изберете Нова регистрация, въведете име на приложение и изберете типа на акаунта.

   Като опция добавете URL адрес за пренасочване. http://localhost е достатъчно за разработване на приложение на вашия локален компютър.

5. Изберете Регистриране.

6. При регистрацията на новото си приложение отидете на разрешения заAPI.

7. Изберете Добавяне на разрешение и изберете Dynamics 365 AI for Customer Insights в страничния екран.

8. За Тип разрешение изберетеДелегирани разрешения и след това изберете user_impersonation разрешение.

9. Изберете Добавяне на разрешения.

10. Изберете Даване на съгласие на администратор за... , за да завършите регистрацията на приложението.

11. За да получите достъп до API, без потребителят да влиза, отидете на Задаване на разрешения заприложения от сървър към сървър.

Можете да използвате ИД на приложение/клиент за регистрация на това приложение в библиотеката за удостоверяване на Microsoft (MSAL), за да получите маркер на приносител, който да изпратите със заявката си до API.

За информация относно използването на API в нашите клиентски библиотеки вижте клиентски библиотеки Customer Insights.

Задаване на разрешения за приложения от сървър към сървър

Създайте регистрация на приложение, която не се нуждае от взаимодействие с потребителя и може да се изпълнява на сървър.

1. При регистрацията на приложението в портала на Azure отидете на разрешения за API.

2. Изберете Добавяне на разрешение.

3. Изберете раздела API, които моята организация използва , и изберете Dynamics 365 AI for Customer Insights от списъка.

4. За Тип разрешение изберете Разрешения за приложения и след това изберетеразрешението api.access .

5. Изберете Добавяне на разрешения.

6. Върнете се към разрешенията за API за регистрацията на приложението си.

7. Изберете Даване на съгласие на администратор за... , за да завършите регистрацията на приложението.

8. Добавете името на регистрацията на приложението като потребител в Customer Insights - Data.

   1. Отвори, Customer Insights - Data отидете на Настройки>Разрешения и изберете Добавяне на потребители.

   2. Потърсете името на регистрацията си в приложението, изберете го от резултатите от търсенето и изберете Запиши.

Примерни заявки

За кратък списък с примерни заявки на OData за работа с API вижте примери за заявки на OData.

Клиентски библиотеки на Customer Insights

Започнете да използвате клиентските библиотеки, налични за Customer Insights - Data API. Всички изходен код на библиотеката и примерни приложения могат да бъдат намерени на репо в GitHub.

C# NuGet

Използвайте клиентските библиотеки на C# from.org NuGet. В момента пакетът е насочен към рамките netstandard2.0 и netcoreapp2.0. За повече информация относно пакета NuGet вижте Microsoft.Dynamics.CustomerInsights.Api.

Добавете клиентската библиотека на C# към проект на C#

1. В Visual Studio отворете диспечера NuGet на пакети за вашия проект.

2. Потърсете Microsoft.Dynamics.CustomerInsights.Api.

3. Изберете Инсталирай , за да добавите пакета към проекта.

   Друга възможност е да изпълните тази команда в конзолата NuGet на диспечера напакети: Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

Използвайте клиентската библиотека на C#

1. Използвайте библиотеката за удостоверяване на Microsoft (MSAL), за да получите регистрация за използване на AccessToken съществуващото приложение на Azure.

2. След успешно удостоверяване и придобиване на маркер, конструирайте нов или използвайте съществуващ HttpClient с DefaultRequestHeaders "Authorization", зададен на Bearer "маркер за достъп" и Ocp-Apim-Subscription-Key , зададен на абонаментния ключ от вашата среда Customer Insights - Data .

   Нулирайте заглавката за удостоверяване , когато е уместно. Например, когато токенът изтече.

3. Прехвърлете това HttpClient в конструкцията на CustomerInsights клиента.

4. Провеждайте разговори с клиента към "методите за разширение", например, GetAllInstancesAsync. Ако се предпочита достъп до базовия актив Microsoft.Rest.HttpOperationResponse , използвайте например "методите GetAllInstancesWithHttpMessagesAsync на http съобщенията".

5. Отговорът вероятно е object тип, защото методът може да върне няколко типа (например,и IList<InstanceInfo> ApiErrorResult). За да проверите типа на връщане, използвайте обектите в типовете отговори, указани на страницата с подробни данни за API за тази операция.

   Ако е необходима повече информация за заявката, използвайте методите на http съобщението , за да получите достъп до необработения обект за отговор.

Пакет NodeJS

Използвайте клиентските библиотеки на NodeJS, достъпни чрез NPM: https://www.npmjs.com/package/@microsoft/customerinsights

Пакет на Python

Използвайте клиентските библиотеки на Python, достъпни чрез PyPi: https://pypi.org/project/customerinsights/