Feedback

Lucrul cu API-urile Customer Insights

  • Articol
  • 4 minute de lectură

Dynamics 365 Customer Insights furnizează API-uri pentru a vă crea propriile aplicații pe baza datelor dvs. în Customer Insights.

Important

Detaliile acestor API-uri sunt listate în Referința de API-uri Customer Insights. Acestea includ informații suplimentare despre operațiuni, parametri și răspunsuri.

Acest articol descrie cum să accesați API-urile Customer Insights, să creați o înregistrare a aplicației Azure și să începeți cu bibliotecile client.

Începeți să încercați API-urile Customer Insights

  1. Conectați-vă la Customer Insights. Dacă nu aveți încă un abonament, înscrieți-vă pentru o versiune de încercare a Customer Insights.

  2. Pentru a activa API-urile în mediul dvs. Customer Insights, accesați Admin > Securitate. Veți avea nevoie de permisiuni de administrator pentru asta.

  3. Accesați fila API-uri și selectați butonul Permite.

    Activarea API-urilor creează o cheie de abonament primară și una secundară pentru instanța dvs. care este folosită în solicitările API. Puteți regenera cheile selectând Regenerați primar sau Regenerează secundar pe Admin > Securitate > API-uri.

  1. Selectați Explorați API-urile noastre pentru a încerca API-urile.

  2. Alegeți o operațiune API și selectați Încearcă.

  3. În panoul lateral, setați valoarea în meniul derulant Autorizare la implicită. Antetul Authorization se adaugă cu un token la purtător. Cheia dvs. de abonament va fi populată automat.

  4. Opțional, adăugați toți parametrii de interogare necesari.

  5. Derulați până în partea de jos a panoului lateral și selectați Trimitere.

Răspunsul HTTP va apărea curând mai jos.

Creați o nouă înregistrare a aplicației în portalul Azure

Acești pași vă ajută să începeți să utilizați API-urile Customer Insights într-o aplicație Azure utilizând permisiuni delegate. Asigurați-vă că completați Secțiunea de început mai întâi.

  1. Conectați-vă la portalul Azure cu contul care poate accesa datele Customer Insights.

  2. În stânga, selectați Înregistrări aplicații.

  3. Selectați Înregistrare nouă, furnizați un nume de aplicație și alegeți tipul de cont.

    Opțional, adăugați o adresă URL de redirecționare. http://localhost este suficient pentru dezvoltarea unei aplicații pe computerul dvs. local.

  4. În noua înregistrare a aplicației, accesați Permisiuni API.

  5. Selectați Adăugați o permisiune și selectați Dynamics 365 AI pentru Customer Insights în panoul lateral.

  6. Pentru Tipul permisiunii, selectați Permisiuni delegate și apoi selectați permisiunea user_impersonation.

  7. Selectați Adăugare permisiuni. Dacă trebuie să accesați API-ul fără conectarea unui utilizator, consultați secțiunea Permisiuni pentru aplicații de la server la server.

  8. Selectați Acordă consimțământul administratorului pentru... pentru a finaliza înregistrarea aplicației.

Puteți utiliza ID-ul aplicației/clientului pentru această înregistrare a aplicației cu Biblioteca de autentificare Microsoft (MSAL) pentru a obține un token pentru purtător pe care îl trimiteți cu cererea dvs. către API.

Pentru mai multe informații despre MSAL, consultați Prezentare generală a bibliotecii de autentificare Microsoft (MSAL).

Pentru mai multe informații despre înregistrarea aplicațiilor în Azure, consultați Înregistrați o aplicație.

Pentru informații despre utilizarea API-urilor în bibliotecile noastre client, consultați Biblioteci client Customer Insights.

Permisiuni pentru aplicații de la server la server

Secțiunea înregistrarea aplicației descrie modul de înregistrare a unei aplicații care necesită conectarea unui utilizator pentru autentificare. Aflați cum să creați o înregistrare a aplicației care nu necesită interacțiunea utilizatorului și care poate fi rulată pe un server.

  1. În înregistrarea aplicației dvs. în portalul Azure, accesați Permisiuni API.

  2. Selectați Adăugați o permisiune.

  3. Selectați fila API-urile pe care le folosește organizația mea și alegeți Dynamics 365 AI for Customer Insights din listă.

  4. Pentru Tip permisiune, selectați Permisiuni de aplicație și apoi selectați permisiunea CustomerInsights.Api.All.

  5. Selectați Adăugare permisiuni.

  6. Reveniți la Permisiuni API pentru înregistrarea aplicației.

  7. Selectați Acordă consimțământul administratorului pentru... pentru a finaliza înregistrarea aplicației.

  1. În concluzie, trebuie să adăugăm numele înregistrării aplicației ca utilizator în Customer Insights.

    Deschideți Customer Insights, accesați Admin > Securitate și selectați Adăugați utilizator.

  2. Căutați numele înregistrării aplicației dvs., selectați-l din rezultatele căutării și selectați Salvare.

Exemple de interogări

Am compilat o listă scurtă de exemple de interogări OData pentru a lucra cu API-urile: Exemple de interogări OData.

Biblioteci client Customer Insights

Această secțiune vă ajută să începeți să utilizați bibliotecile client disponibile pentru API-urile Customer Insights. Toate codurile sursă ale bibliotecii și exemplele de aplicații pot fi găsite pe pagina GitHub Customer Insights.

C# NuGet

Aflați cum să începeți să utilizați bibliotecile client C# de la NuGet.org. Pentru mai multe informații despre pachetul NuGet, consultați Microsoft.Dynamics.CustomerInsights.Api. În prezent, acest pachet vizează cadrele netstandard2.0 și netcoreapp2.0.

Adăugați biblioteca client C# la un proiect C#

  1. În Visual Studio, deschideți Manager pachet NuGet pentru proiectul dumneavoastră.

  2. Căutați Microsoft.Dynamics.CustomerInsights.Api.

  3. Selectați Instalare pentru a adăuga pachetul la proiect.

    Alternativ, rulați această comandă în Consola Manager pachet NuGet: Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

Utilizați biblioteca de client C#

  1. Folosiți Biblioteca de autentificare Microsoft (MSAL) pentru a obține un AccessToken folosind înregistrarea aplicației Azure existentă.

  2. După autentificarea și achiziția cu succes a unui token, construiți unul nou sau utilizați unul existentHttpClient cu DefaultRequestHeaders „Autorizare” setat la „Jeton de acces” purtător și Ocp-Apim-Subscription-Key setat la cheie de abonament din mediul dvs. Customer Insights.

    Resetați antetul Autorizare când este cazul. De exemplu, când tokenul a expirat.

  3. Introduceți această HttpClient în construcția clientului CustomerInsights.

  1. Efectuați apeluri cu clientul pentru „metodele de extensie”,"—de exemplu, GetAllInstancesAsync. Dacă accesul la Microsoft.Rest.HttpOperationResponse subiacent este preferat, utilizați „metode de mesaj http”—de exemplu GetAllInstancesWithHttpMessagesAsync.

  2. Răspunsul va fi probabil de tip object deoarece metoda poate returna mai multe tipuri (de exemplu, IList<InstanceInfo> și ApiErrorResult). Pentru a verifica tipul de returnare, utilizați obiectele din tipurile de răspuns specificate pe Pagina de detalii API pentru acea operațiune.

    Dacă sunt necesare mai multe informații la cerere, utilizați metode mesaj http pentru a accesa obiectul de răspuns brut.

Pachetul NodeJS

Utilizați bibliotecile client NodeJS disponibile prin NPM: https://www.npmjs.com/package/@microsoft/customerinsights

Pachet Python

Utilizați bibliotecile client Python disponibile prin PyPi: https://pypi.org/project/customerinsights/

Notă

Ne puteți spune care preferințele dvs. lingvistice pentru documentație? Răspundeți la un chestionar scurt. (rețineți că acest chestionar este în limba engleză)

Chestionarul va dura aproximativ șapte minute. Nu sunt colectate date personale (angajament de respectare a confidențialității).