Praca z interfejsami API aplikacji Customer Insights - Data

Dynamics 365 Customer Insights - Data udostępnia interfejsy API do tworzenia własnych aplikacji na podstawie danych zgromadzonych w usłudze Customer Insights. Szczegóły dotyczące tych API znajdziesz w referencji API, która zawiera informacje o operacjach, parametrach i odpowiedziach.

Rozpocznij testowanie interfejsów API

Administrator musi włączyć dostęp do danych za pomocą interfejsu API. Po włączeniu dostępu każdy użytkownik może używać interfejsu API z kluczem subskrypcji.

1. Zaloguj się do usługi Customer Insights — dane lub utwórz konto w celu uzyskania wersji próbnej usługi Customer Insights.

2. Przejdź do pozycji Ustawienia>Uprawnienia i wybierz kartę Interfejsy API .

3. Jeśli dostęp API do środowiska nie jest skonfigurowany, wybierz Enable.

   Po włączeniu API tworzysz główny i dodatkowy klucz subskrypcyjny dla swojego środowiska, którego używasz w żądaniach API. Aby wygenerować klucze, wybierz Generuj podstawę lub Regeneruj wtórną na zakładce API.

4. Wybierz pozycję Eksploruj nasze interfejsy API , aby wypróbować interfejsy API.

5. Wyszukaj i wybierz operację interfejsu API, a następnie wybierz pozycję Wypróbuj.

   

6. W panelu bocznym ustaw w menu rozwijanym Authorization wartość implicit. Nagłówek Authorization jest dodawany z tokenem elementu nośnego. Klucz subskrypcji jest wypełniany automatycznie.

7. Opcjonalnie dodaj wszystkie niezbędne parametry zapytania.

8. Przewiń do dołu okienka bocznego i wybierz pozycję Wyślij.

   Odpowiedź HTTP jest wyświetlana w dolnej części okienka.

Tworzenie nowej rejestracji aplikacji w witrynie Azure Portal

Utwórz nową rejestrację aplikacji, aby korzystać z API w aplikacji Azure, korzystając z delegowanych uprawnień.

1. Ukończ sekcję Wprowadzenie.

2. Zaloguj się do witryny Azure Portal przy użyciu konta, które może uzyskiwać dostęp do danych usługi Customer Insights.

3. Wyszukaj, a następnie wybierz pozycję Rejestracje aplikacji.

4. Wybierz Nową rejestrację, podaj nazwę aplikacji i wybierz typ konta.

   Opcjonalnie dodaj adres URL przekierowania. http://localhost jest wystarczająca do tworzenia aplikacji na komputerze lokalnym.

5. Wybierz pozycję Zarejestruj.

6. Po rejestracji nowej aplikacji przejdź do uprawnień API.

7. Wybierz pozycję Dodaj uprawnienie i wybierz pozycję Dynamics 365 AI for Customer Insights w okienku bocznym.

8. W polu Typ uprawnień wybierz pozycję Uprawnienia delegowane , a następnie wybierz uprawnienie user_impersonation .

9. Wybierz pozycję Dodaj uprawnienia.

10. Wybierz pozycję Udziel zgody administratora dla... aby ukończyć rejestrację aplikacji.

11. Aby uzyskać dostęp do interfejsu API bez logowania użytkownika, przejdź do pozycji Ustawianie uprawnień aplikacji serwer-serwer.

Możesz użyć identyfikatora aplikacji/klienta do rejestracji tej aplikacji z biblioteką uwierzytelniania Microsoft (MSAL), aby uzyskać token elementu nośnego do wysłania z żądaniem do interfejsu API.

Aby uzyskać informacje na temat korzystania z interfejsów API w naszych bibliotekach klienckich, zobacz Biblioteki klienta usługi Customer Insights.

Ustaw uprawnienia aplikacji serwer-serwerowej

Stwórz rejestrację aplikacji, która nie wymaga interakcji użytkownika i może działać na serwerze.

1. W rejestracji aplikacji w witrynie Azure Portal przejdź do obszaru uprawnień interfejsu API.

2. Wybierz pozycję Dodaj uprawnienie.

3. Wybierz kartę Interfejsy API używane przez moją organizację , a następnie z listy wybierz pozycję Dynamics 365 AI for Customer Insights .

4. W polu Typ uprawnień wybierz pozycję Uprawnienia aplikacji , a następnie wybierz uprawnienie api.access .

5. Wybierz pozycję Dodaj uprawnienia.

6. Wróć do uprawnień interfejsu API w rejestracji swojej aplikacji.

7. Wybierz pozycję Udziel zgody administratora dla... aby ukończyć rejestrację aplikacji.

8. Dodaj nazwę rejestracji aplikacji jako użytkownika w usłudze Customer Insights - Data.

   1. Otwórz usługę Customer Insights — dane, przejdź do pozycji Uprawnienia ustawień> i wybierz pozycję Dodaj użytkowników.

   2. Wyszukaj nazwę rejestracji aplikacji, wybierz ją z wyników wyszukiwania i wybierz pozycję Zapisz.

Przykładowe zapytania

Aby uzyskać krótką listę przykładowych zapytań OData do pracy z interfejsami API, zobacz Przykłady zapytań OData.

Biblioteki klienckie usługi Customer Insights

Rozpocznij pracę z bibliotekami klienckimi dostępnymi dla interfejsów API Customer Insights - Data. Wszystkie kody źródłowe biblioteki i przykładowe aplikacje można znaleźć w repozytorium GitHub.

C# NuGet

Użyj bibliotek klienckich języka C# z NuGet.org. Obecnie pakiet jest przeznaczony dla platform netstandard2.0 i netcoreapp2.0. Więcej informacji o pakiecie NuGet można znaleźć na Microsoft.Dynamics. CustomerInsights.Api.

Dodawanie biblioteki klienta języka C# do projektu C#

1. W programie Visual Studio otwórz Menedżera pakietów NuGet dla projektu.

2. Wyszukaj Microsoft.Dynamics.CustomerInsights.Api.

3. Wybierz pozycję Zainstaluj , aby dodać pakiet do projektu.

   Alternatywnie uruchom to polecenie w konsoli Menedżera pakietów NuGet: Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

Korzystanie z biblioteki klienta języka C#

1. Użyj biblioteki uwierzytelniania firmy Microsoft (MSAL), aby uzyskać AccessToken za pomocą istniejącej rejestracji aplikacji platformy Azure.

2. Po uwierzytelnieniu i zdobyciu tokena zbuduj nowy HttpClient lub użyj istniejącego. Ustaw DefaultRequestHeaders „Authorization” na wartość Bearer „access token” i ustaw Ocp-Apim-Subscription-Key na klucz subskrypcji z Twojego środowiska Customer Insights - Data.

   W razie potrzeby zresetuj nagłówek Authorization. Na przykład, gdy token wygasa.

3. Przekaż element HttpClient do konstrukcji klienta CustomerInsights.

4. Wywołaj z klientem „metody rozszerzające”, na przykład GetAllInstancesAsync. Jeśli wolisz dostęp do bazowego Microsoft.Rest.HttpOperationResponse, użyj „metod komunikatów HTTP”, na przykład GetAllInstancesWithHttpMessagesAsync.

5. Odpowiedź jest prawdopodobnie object typem, ponieważ metoda może zwracać wiele typów (na przykład IList<InstanceInfo> i ApiErrorResult). Aby sprawdzić typ zwracany, użyj obiektów w typach odpowiedzi określonych na stronie szczegółów interfejsu API dla tej operacji.

   Jeśli potrzebujesz więcej informacji o żądaniu, użyj metod HTTP message , aby uzyskać dostęp do surowego obiektu odpowiedzi.

Node.js pakiet

Korzystaj z Node.js bibliotek klientów dostępnych przez NPM: https://www.npmjs.com/package/@microsoft/customerinsights

Pakiet języka Python

Użyj bibliotek klienckich języka Python dostępnych za pośrednictwem interfejsu PyPi: https://pypi.org/project/customerinsights/