Delo z API-ji za Customer Insights

Dynamics 365 Customer Insights ponuja API-je za izdelavo lastnih aplikacij, ki temeljijo na vaših podatkih v storitvi Customer Insights.

Pomembno

Podrobnosti o teh API-jih so navedene pri sklicu za API-je za Customer Insights. Vključujejo dodatne informacije o postopkih, parametrih in odzivih.

Ta članek vas pomaga pri dostopu do API-jev za Customer Insights, ustvarjanju registracije aplikacije Azure in začetku uporabe razpoložljivih odjemalskih knjižnic.

Začetek uporabe API-jev za Customer Insights

  1. Vpišite se v aplikacijo Customer Insights. Če še nimate naročnine, se prijavite za preskusno različico aplikacije Customer Insights.

  2. Če želite omogočiti API-je v okolju Customer Insights, izberite Skrbnik > Dovoljenja. Za to boste potrebovali skrbniška dovoljenja.

  3. Izberite zavihek API-ji in izberite gumb Omogoči.
    Z omogočanjem API-jev se ustvari primarni in sekundarni naročniški ključ za vaš primerek, ki se uporablja v zahtevah API-ja. Ključe lahko znova ustvarite tako, da izberete Znova ustvari primarnega ali Znova ustvari sekundarnega v razdelku Skrbnik > Dovoljenja > API-ji.

    Omogočite API-je za Customer Insights

  4. Izberite Raziskovanje API-jev, da preizkusite API-je.

  5. Izberite postopek API-ja in izberite Preskusi.

  6. V stranskem podoknu nastavite vrednost v spustnem meniju Avtorizacija na implicitno. Pri glavi Authorization se doda nosilni žeton. Vaš naročniški ključ bo samodejno izpolnjen.

  7. Po želji dodajte vse potrebne parametre poizvedbe.

  8. Pomaknite se na dno stranskega podokna in izberite Pošlji.

Odgovor HTTP se bo kmalu prikazal spodaj.

Animirani gif, ki prikazuje, kako izbrati test API-jev.

Ustvarjanje registracije nove aplikacije v portalu Azure

Ti koraki vam pomagajo začeti uporabljati API-je za Customer Insights v aplikaciji Azure z uporabo dodeljenih dovoljenj. Najprej se prepričajte, da ste zaključili razdelek za začetek.

  1. Vpišite se v portal Azure z računom, ki lahko dostopa do podatkov Customer Insights.

  2. Na levi izberite Registracije aplikacij.

  3. Izberite Nova registracija ter navedite ime aplikacije in izberite vrsto računa. Lahko tudi dodate URL za preusmeritev. http://localhost zadostuje za razvoj aplikacije v vašem lokalnem računalniku.

  4. V razdelku za registracijo nove aplikacije izberite Dovoljenja za API.

    Animirani gif za nastavitev dovoljenja za API pri registraciji aplikacije.

  5. Izberite Dodaj dovoljenje in zatem Customer Insights v stranskem podoknu.

  6. Za možnost Vrsta dovoljenja izberite Dodeljena dovoljenja in izberite dovoljenje user_impersonation.

  7. Izberite Dodaj dovoljenja. Če morate do API-ja dostopati brez vpisa uporabnika, preberite razdelek Dovoljenja aplikacij za povezovanje med strežniki.

  8. Izberite Podeli soglasje skrbnika za ..., da dokončate registracijo aplikacije.

ID aplikacije/odjemalca lahko uporabite za registracijo te aplikacije v knjižnici za preverjanje pristnosti Microsoft Authentication Library (MSAL), da prejmete nosilni žeton, ki ga z vašo zahtevo pošljete v API.

Animirani gif za odobritev soglasja skrbnika.

Za več informacij o knjižnici MSAL glejte Pregled knjižnice Microsoft Authentication Library (MSAL).

Če želite več informacij o registraciji aplikacij v storitvi Azure, glejte razdelek Nova izkušnja pri registraciji aplikacije portala Azure.

Za informacije o uporabi API-jev pri naših odjemalskih knjižnicah glejte Odjemalske knjižnice Customer Insights.

Dovoljenja aplikacij za povezovanje med strežniki

Razdelek za registracijo aplikacije opisuje, kako registrirati aplikacijo, ki za preverjanje pristnosti od uporabnika zahteva vpis. Naučite se ustvariti registracijo aplikacije, ki ne potrebuje interakcije uporabnika in jo je mogoče zagnati v strežniku.

  1. Pri registraciji aplikacije v portalu Azure izberite Dovoljenja za API.

  2. Izberite Dodaj dovoljenje in zatem Customer Insights v stranskem podoknu.

  3. Za možnost Vrsta dovoljenja izberite Dovoljenja aplikacije in izberite dovoljenje CustomerInsights.Api.All.

  4. Izberite Dodaj dovoljenja.

  5. Če želite podati skrbniško soglasje za to dovoljenje aplikacije, morate dodati glavno ime storitve.

    1. Namestite modul Azure Active Directory (AD) PowerShell: Install-Module -Name AzureAD -AllowClobber -Scope AllUsers
    2. Povežite račun AD: Connect-AzureAD -TenantId <your tenant id>. ID najemnika lahko najdete v razdelku Pregled > Azure Active Directory.
    3. Zaženite naslednji ukaz, da dodate glavno ime storitve Azure AD: New-AzureADServicePrincipal -AppId "38c77d00-5fcb-4cce-9d93-af4738258e3c" -DisplayName "Microsoft Dynamics 365 Customer Insights". Parameter AppId se nanaša na aplikacijo API-ja za Customer Insights.

    Vzorec glavnega imena storitve

  6. Vrnite se v razdelek Dovoljenja za API, da registrirate aplikacijo.

  7. Izberite Podeli soglasje skrbnika za ..., da dokončate registracijo aplikacije.

    Animirani gif za odobritev soglasja skrbnika.

  8. Na koncu moramo še dodati ime registracije aplikacije kot uporabnik v storitvi Customer Insights.
    Odprite Customer Insights, izberite Skrbnik > Dovoljenja in izberite Dodaj uporabnika.

  9. Poiščite ime registracije za svojo aplikacijo, izberite ga med rezultati iskanja in izberite Shrani.

Odjemalske knjižnice Customer Insights

Ta razdelek vam pomaga začeti uporabljati odjemalske knjižnice, ki so na voljo za API-je za Customer Insights. Vse izvorne kode knjižnice in vzorčne aplikacije najdete na strani Customer Insights GitHub.

C# NuGet

Naučite se uporabljati odjemalske knjižnice C# storitve NuGet.org. Za več informacij o paketu NuGet glejte Microsoft.Dynamics.CustomerInsights.Api. Trenutno ta paket cilja na ogrodja netstandard2.0 in netcoreapp2.0.

Dodajanje odjemalske knjižnice C# v projekt C#

  1. V storitvi Visual Studio odprite upravitelja paketov NuGet za svoj projekt.

  2. Poiščite Microsoft.Dynamics.CustomerInsights.Api.

  3. Izberite Namesti za dodajanje paketa v projekt. Ta ukaz lahko zaženete tudi v konzoli upravitelja paketov NuGet: Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

    Dodajte paket NuGet v projekt Visual Studio

Uporaba odjemalske knjižnice C#

  1. Uporabite knjižnico Microsoft Authentication Library (MSAL), da prejmete AccessToken z uporabo obstoječe registracije aplikacije Azure.

  2. Po uspešnem preverjanju pristnosti in pridobitvi žetona izdelajte novega oz. uporabite obstoječega odjemalca HttpClient, in sicer z dodatno »avtorizacijo« DefaultRequestHeaders nastavljeno na Nosilec in možnostjo Ocp-Apim-Subscription-Key nastavljeno na naročniški ključ iz okolja Customer Insights.
    Ponastavite glavo Avtorizacija, kadar je to primerno. Na primer, ko je žeton potekel.

  3. Odjemalca HttpClient posredujte za pripravo odjemalca CustomerInsights.

    Vzorec odjemalca httpclient

  4. Z odjemalcem prikličite »načine razširitve«, na primer GetAllInstancesAsync. Če je zaželen dostop do temeljne možnosti Microsoft.Rest.HttpOperationResponse, uporabite »načine sporočil http«, na primer GetAllInstancesWithHttpMessagesAsync.

  5. Vrsta odziva bo verjetno object, ker lahko ta način vrne več vrst (na primer IList<InstanceInfo> in ApiErrorResult). Če želite preveriti vrsto vrnitve, lahko predmete varno pretvorite v vrste odzivov, določene na strani s podrobnostmi o API-ju za ta postopek.
    Če potrebujete več informacij o zahtevi, uporabite načine sporočil http za dostop do predmeta neobdelanega odziva.

Paket NodeJS

Uporabite odjemalske knjižnice NodeJS, ki so na voljo v programski opremi NPM: https://www.npmjs.com/package/@microsoft/customerinsights

Paket Python

Uporabite odjemalske knjižnice Python, ki so na voljo v programski opremi PyPi: https://pypi.org/project/customerinsights/