Rad s API-jima Customer Insights

Dynamics 365 Customer Insights pruža API-je za izradu vlastitih aplikacija na temelju vaših podataka u Customer Insights.

Važno

Pojedinosti o tim API-jima navedeni su u Referenci za API-je za Customer Insights. Oni uključuju dodatne informacije o operacijama, parametrima i odgovorima.

Ovaj članak vodi vas do pristupa API-jiima za Customer Insights, izrade registracije Azure aplikacije i pomoći vam da započnete s dostupnim klijentskim bibliotekama.

Početak s isprobavanjem API-ja za Customer Insights

  1. Prijavite se u Customer Insights. Ako još nemate pretplatu, prijavite se za probnu verziju Customer Insights.

  2. Da biste omogućili API-je u svom okruženju Customer Insights, idite na Administrator > Dozvole. Za to će vam trebati administratorske dozvole.

  3. Idite na karticu API-ji pa odaberite gumb Omogući.
    Omogućavanjem API-ja stvara se primarni i sekundarni ključ pretplate za vašu instancu koji se koristi u zahtjevima API-ja. Ključeve možete ponovno generirati odabirom Ponovno generiraj primarni ili Ponovno generiraj sekundarni na Administrator > Dozvole > API-ji.

    Omogućavanje API-jeva za Customer Insights

  4. Odaberite Istražite naše API-je da isprobate API-je.

  5. Odaberite operaciju API-ja pa odaberite Isprobaj.

  6. U bočnom oknu vrijednost u padajućem izborniku Ovlaštenje postavite na implicitno. Zaglavlje Authorization dobiva s dodanim tokenom nositelja. Vaš ključ pretplate automatski će se popuniti.

  7. Po želji dodajte sve potrebne parametre upita.

  8. Pomaknite se do dna bočnog okna pa odaberite Pošalji.

HTTP odgovor uskoro će se pojaviti u nastavku.

Stvaranje nove registracije aplikacije na Azure portalu

Ovi vam koraci pomažu u početku korištenja API-ja Customer Insights u Azure aplikaciji pomoću delegiranih dozvola. Svakako prvo dovršite odjeljak Početak.

  1. Prijavite se na Azure portal s računom koji može pristupiti podacima Customer Insights.

  2. S lijeve strane odaberite Registracije aplikacija.

  3. Odaberite Nova registracija, navedite naziv aplikacije pa odaberite vrstu računa. Ako želite, dodajte URL preusmjeravanja. http://localhost dovoljan je za razvoj aplikacije na vašem lokalnom računalu.

  4. Na novoj registraciji aplikacije idite na Dozvole API-ja.

  5. Odaberite Dodaj dozvolu pa odaberite Customer Insights u bočnom oknu.

  6. Za Vrsta dozvole odaberite Delegirane dozvole pa odaberite dozvolu user_impersonation.

  7. Odaberite Dodaj dozvole. Ako trebate pristupiti API-ju bez prijave korisnika, pregledajte odjeljak Dozvole aplikacija s poslužitelja na poslužitelj.

  8. Odaberite Daj pristanak administratora za... da biste dovršili registraciju aplikacije.

Možete koristiti ID aplikacije/klijenta za registraciju ove aplikacije u Microsoftovoj biblioteci za provjeru autentičnosti (MSAL) da biste dobili token nositelja koji će se s vašim zahtjevom poslati API-ju.

Za više informacija o MSAL-u pogledajte Pregled Microsoftove biblioteke za provjeru autentičnosti (MSAL).

Za više informacija o registraciji aplikacija na platformi Azure pogledajte Novo iskustvo registracije aplikacija Azure portala.

Za informacije o korištenju API-ja naših klijentskih biblioteke pogledajte Klijentske biblioteke Customer Insights.

Dozvole aplikacije s poslužitelja na poslužitelj

U odjeljku za registraciju aplikacije opisuje se kako registrirati aplikaciju koja zahtijeva da se korisnik prijavi radi provjere autentičnosti. Saznajte kako stvoriti registraciju aplikacije koja ne treba interakciju korisnika i može se pokrenuti na poslužitelju.

  1. Na registraciji svoje aplikacije na Azure portalu idite na Dozvole API-ja.

  2. Odaberite Dodaj dozvolu pa odaberite Customer Insights u bočnom oknu.

  3. Za Vrsta dozvole odaberite Dozvole aplikacija pa odaberite dozvolu CustomerInsights.Api.All.

  4. Odaberite Dodaj dozvole.

  5. Da biste dali pristanak administratora na ovu dozvolu aplikaciju, morate dodati upravitelja servisa.

    1. Instalirajte Azure Active Directory (AD) PowerShell modul: Install-Module -Name AzureAD -AllowClobber -Scope AllUsers
    2. Povežite se na svoj račun za AD: Connect-AzureAD -TenantId <your tenant id>. Svoj ID klijenta možete pronaći na Pregled > Azure Active Directory.
    3. Pokrenite sljedeću naredbu za dodavanje Azure AD upravitelja servisa: New-AzureADServicePrincipal -AppId "38c77d00-5fcb-4cce-9d93-af4738258e3c" -DisplayName "Microsoft Dynamics 365 Customer Insights" Parametar AppId odnosi se na aplikaciju Customer Insights API-ja.

    Ogledni upravitelj servisa

  6. Vratite se na Dozvole API-ja za registraciju svoje aplikacije.

  7. Odaberite Daj pristanak administratora za... da biste dovršili registraciju aplikacije.

  8. Da zaključimo, moramo dodati naziv registracije aplikacije kao korisnika u Customer Insights.
    Otvorite Customer Insights, idite na Administrator > Dozvole pa odaberite Dodaj korisnika.

  9. Potražite naziv registracije svoje aplikacije, odaberite ga iz rezultata pretraživanja pa odaberite Spremi.

Klijentske biblioteke Customer Insights

Ovaj vam odjeljak pomaže u početku korištenja klijentskih knjižnica dostupnih za API-je Customer Insights.

C# NuGet

Naučite kako započeti s korištenjem klijentskih biblioteka za C# s NuGet.org. Za više informacija o paketu NuGet pogledajte Microsoft.Dynamics.CustomerInsights.Api. Trenutačno ovaj paket cilja okvire netstandard2.0 i netcoreapp2.0.

Dodavanje klijentske biblioteke za C# projektu u C#

  1. U Visual Studio otvorite Upravitelj paketa NuGet za svoj projekt.

  2. Potražite Microsoft.Dynamics.CustomerInsights.Api.

  3. Odaberite Instaliraj za dodavanje paketa u projekt. Alternativno, pokrenite ovu naredbu u Konzoli upravitelja paketa NuGet: Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

    Dodavanje NuGet paketa Visual Studio projektu

Korištenje klijentske biblioteke za C#

  1. Koristite Microsoftovu biblioteku za provjeru autentičnosti (MSAL) da biste dobili AccessToken koristeći svoju postojeću Registraciju Azure aplikacije.

  2. Nakon uspješne autentifikacije i stjecanja tokena, izgradite novi ili upotrijebite postojeći HttpClient s dodatnim DefaultRequestHeaders "Authorization" postavljenim na Nositelj i Ocp-Apim-Subscription-Key postavljenim na ključ pretplate iz svog okruženja Customer Insights.
    Po potrebi resetirajte zaglavlje Authorization. Primjerice, kada token istekne.

  3. Proslijedite ovaj HttpClient u izgradnju klijenta CustomerInsights.

    Ogledni httpclient

  4. Uputite pozive s klijentom na „metode produženja“,, primjerice GetAllInstancesAsync. Ako se preferira pristup temeljnom Microsoft.Rest.HttpOperationResponse, upotrijebite "metode poruka http", primjerice GetAllInstancesWithHttpMessagesAsync.

  5. Odgovor će vjerojatno biti vrste object jer metoda može vratiti više vrsta (primjerice IList<InstanceInfo> i ApiErrorResult). Da biste provjerili vrstu povrata, možete sigurno pretvoriti objekte u vrste odgovora navedene na stranica s pojedinostima API-ja za tu operaciju.
    Ako su potrebne dodatne informacije o zahtjevu, upotrijebite http metode poruka za pristup neobrađenom objektu odgovora.