Praca z usługą Customer Insights — interfejsy API danych

Dynamics 365 Customer Insights — dane udostępniają interfejsy API do tworzenia własnych aplikacji na podstawie danych w usłudze Customer Insights. Szczegółowe informacje o tych interfejsach API znajdują się w dokumentacji interfejsu API. Zawierają one dodatkowe informacje o operacjach, parametrach i odpowiedziach.

Wprowadzenie do próby użycia 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 interfejsu API do środowiska nie został skonfigurowany, wybierz pozycję Włącz.

   Włączenie interfejsów API powoduje utworzenie podstawowego i pomocniczego klucza subskrypcji dla środowiska, które jest używane w żądaniach interfejsu API. Aby ponownie wygenerować klucze, wybierz kartę Ponowne generowanie podstawowej lub Ponownie wygeneruj pomocniczą na karcie Interfejsy 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 okienku bocznym ustaw wartość w menu rozwijanym Autoryzacja na niejawną. Nagłówek Authorization jest dodawany przy użyciu tokenu 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 używać interfejsów API w aplikacji platformy Azure przy użyciu 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 pozycję Nowa rejestracja, 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. W nowej rejestracji aplikacji przejdź do pozycji Uprawnienia interfejsu 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.

Aby uzyskać token elementu nośnego do wysłania żądania do interfejsu API, możesz użyć identyfikatora aplikacji/klienta dla tej rejestracji aplikacji za pomocą biblioteki Microsoft Authentication Library (MSAL ).

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

Ustawianie uprawnień aplikacji serwer-serwer

Utwórz rejestrację aplikacji, która nie wymaga interakcji z użytkownikiem i może być uruchamiana na serwerze.

1. W rejestracji aplikacji w witrynie Azure Portal przejdź do pozycji Uprawnienia 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 pozycji Uprawnienia interfejsu API do rejestracji 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 — dane.

   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 klienta usługi Customer Insights

Rozpocznij korzystanie z bibliotek klienckich dostępnych dla interfejsów API Customer Insights — Dane. Cały kod źródłowy 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. Aby uzyskać więcej informacji na temat pakietu NuGet, zobacz 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 ciąg 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 Microsoft Authentication Library (MSAL), aby uzyskać konto AccessToken przy użyciu istniejącej rejestracji aplikacji platformy Azure.

2. Po pomyślnym uwierzytelnieniu i uzyskaniu tokenu skonstruuj nowy lub użyj istniejącego HttpClient z ustawieniem DefaultRequestHeaders "Authorization" (Autoryzacja) elementu nośnego "token dostępu" i kluczem subskrypcji Ocp-Apim-Subscription-Key ustawionym na klucz subskrypcji ze środowiska Customer Insights — dane.

   W razie potrzeby zresetuj nagłówek autoryzacji . Na przykład po wygaśnięciu tokenu.

3. Przekaż to HttpClient do konstrukcji CustomerInsights klienta.

4. Wywołania należy wykonać za pomocą klienta do "metod rozszerzeń", na przykład GetAllInstancesAsync. Jeśli dostęp do bazowego Microsoft.Rest.HttpOperationResponse jest preferowany, 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 na temat żądania, użyj metod komunikatów HTTP , aby uzyskać dostęp do nieprzetworzonego obiektu odpowiedzi.

Pakiet NodeJS

Użyj bibliotek klienckich NodeJS dostępnych za pośrednictwem narzędzia 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/