Робота з API Customer Insights - Data

Dynamics 365 Customer Insights - Data надає API для створення власних додатків на основі ваших даних у Customer Insights. Детальна інформація про ці API вказана в довіднику API. Вони містять додаткові відомості про операції, параметри та відповіді.

Нотатка

Customer Insights - Data Доступ до таблиць також можна отримати за допомогою Dataverse API. Ми рекомендуємо використовувати Dataverse API для запиту даних статистики клієнтів, оскільки вони пропонують ширшу фільтрацію, більшу пропускну здатність і меншу затримку. Щоб дізнатися більше, перегляньте статтю Dataverse API для статистики клієнтів.

Почніть пробувати API

Адміністратор повинен увімкнути API-доступ до ваших даних. Після ввімкнення доступу будь-який користувач може використовувати API з ключем підписки.

1. увійдіть або Customer Insights - Data зареєструйтеся для отримання пробної версії Customer Insights.

2. Перейдіть до налаштувань Дозволи> та виберіть вкладку API .

3. Якщо доступ API до середовища не налаштовано, виберіть Увімкнути.

   Увімкнення API створює основний і додатковий ключ підписки для вашого середовища, який використовується в запитах API. Щоб повторно згенерувати ключі, виберіть Регенерувати первинний або Регенерувати вторинний на вкладці 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 Authentication Library (MSAL), щоб зареєструватися AccessToken в наявнійпрограмі Azure.

2. Після успішної автентифікації та отримання токена, створіть новий або використовуйте існуючий HttpClient з DefaultRequestHeaders "Authorization", встановленим на Bearer "access token" та Ocp-Apim-Subscription-Key , встановленим на ключ підписки з вашого Customer Insights - Data середовища.

   Скиньте заголовок Authorization, коли це необхідно. Наприклад, коли термін дії маркера минув.

3. Передайте це HttpClient в конструкцію CustomerInsights клієнта.

4. Здійснюйте дзвінки з клієнтом на "методи розширення", наприклад, GetAllInstancesAsync. Якщо перевага надається доступу до базових даних Microsoft.Rest.HttpOperationResponse , скористайтеся "методами повідомлень http", наприклад, GetAllInstancesWithHttpMessagesAsync.

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/