Deli z drugimi prek

Delo z API-ji za Customer Insights - Data

  • Članek

Dynamics 365 Customer Insights - Data API-jem zagotavlja ustvarjanje lastnih aplikacij na podlagi vaših podatkov v storitvi Customer Insights. Podrobnosti o teh API-jih so navedene v sklicu API-ja. Vključujejo dodatne informacije o postopkih, parametrih in odzivih.

opomba,

Customer Insights - Data Do tabel lahko dostopate tudi z API-ji Dataverse . Priporočamo, da uporabite Dataverse API-je za poizvedovanje po podatkih vpogledov strankam, saj ponujajo obsežnejše filtriranje, večjo prepustnost in manjšo zakasnitev. Če želite več informacij, glejte Dataverse API-ji za vpoglede v stranke.

Začnite preizkušati API-je

Skrbnik mora omogočiti dostop API-ja do vaših podatkov. Ko je dostop omogočen, lahko vsak uporabnik uporablja API z naročniškim ključem.

  1. prijavite se Customer Insights - Data ali prijavite za preskusno različico storitve Customer Insights.

  2. Pojdite na Dovoljenja za nastavitve>in izberite zavihek API-ji .

  3. Če dostop API-ja do okolja ni nastavljen, izberite Omogoči.

    Če omogočite API-je, ustvarite primarni in sekundarni naročniški ključ za vaše okolje, ki se uporablja v zahtevah API-ja. Če želite obnoviti ključe, na zavihku API-ji izberite Obnovi primarni ali Obnovi sekundarno .

  4. Izberite Raziščite naše API-je , da preizkusite API-je.

  5. Poiščite in izberite operacijo API-ja ter izberitePoskusite.

    Kako preizkusiti API-je.

  6. V stranskem podoknu nastavite vrednost v spustnem meniju Avtorizacija na implicitno. Glava Authorization se doda z žetonom prinosnika. Naročniški ključ se samodejno izpolni.

  7. Po želji dodajte vse potrebne parametre poizvedbe.

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

    Odziv HTTP se prikaže na dnu podokna.

Ustvarjanje registracije nove aplikacije v portalu Azure

Ustvarite novo registracijo aplikacije za uporabo API-jev v aplikaciji Azure z uporabo pooblaščenih dovoljenj.

  1. Dokončajte razdelek Uvod.

  2. v portal Azure se prijavite z računom, ki lahko dostopa do podatkov storitve Customer Insights.

  3. Poiščite in nato izberite Registracije aplikacij.

  4. Izberite Nova registracija, vnesite ime aplikacije in izberite vrsto računa.

    Lahko tudi dodate URL za preusmeritev. http://localhost zadostuje za razvoj aplikacije na vašem lokalnem računalniku.

  5. Izberite Registriraj.

  6. Pri novi registraciji aplikacije odprite dovoljenja API-ja.

  7. Izberite Dodaj dovoljenje in v stranskem podoknu izberite Dynamics 365 AI for Customer Insights .

  8. Za Vrsta dovoljenja izberitePooblaščena dovoljenja in nato user_impersonation dovoljenje.

  9. Izberite Dodaj dovoljenja.

  10. Izberite Podeli skrbniško soglasje za ... , da dokončate registracijo aplikacije.

  11. Če želite dostopati do API-ja, ne da bi se uporabnik prijavil, pojdite na Nastavitev medstrežniških dovoljenj za aplikacije.

ID programa/odjemalca lahko uporabite za to registracijo aplikacije v Microsoftovi knjižnici za preverjanje pristnosti (MSAL), da pridobite žeton prinosnika, ki ga lahko pošljete API-ju skupaj z zahtevo.

Če želite informacije o uporabi API-jev v naših knjižnicah strank, glejte Knjižnice odjemalcev storitev Customer Insights.

Nastavljanje medstrežniških dovoljenj za aplikacije

Ustvarite registracijo aplikacije, ki ne potrebuje interakcije uporabnika in jo je mogoče zagnati v strežniku.

  1. Pri registraciji aplikacije na portalu Azure odprite dovoljenja API-ja.

  2. Izberite Dodaj dovoljenje.

  3. Izberite zavihek API-jev, ki jih uporablja moja organizacija, in na seznamu izberite Dynamics 365 AI for Customer Insights .

  4. Za Vrsta dovoljenja izberite Dovoljenja programa in nato dovoljenje api.access.

  5. Izberite Dodaj dovoljenja.

  6. Vrnite se na dovoljenja API-ja za registracijo aplikacije.

  7. Izberite Podeli skrbniško soglasje za ... , da dokončate registracijo aplikacije.

  8. Dodajte ime registracije aplikacije kot uporabnika Customer Insights - Data.

    1. Odprite Customer Insights - Data, pojdite na Nastavitve>Dovoljenja in izberite Dodaj uporabnike.

    2. Poiščite ime svoje registracije aplikacije, ga izberite med rezultati iskanja in izberite Shrani.

Vzorčne poizvedbe

Za kratek seznam vzorčnih poizvedb OData za delo z API-ji glejte Primeri poizvedb OData.

Odjemalske knjižnice Customer Insights

Začnite uporabljati odjemalske knjižnice, ki so na voljo za Customer Insights - Data API-je. Vso izvorno kodo knjižnice in vzorčne aplikacije lahko najdete na GitHub repo.

C# NuGet

Uporabite odjemalske knjižnice C# iz NuGet.org. Trenutno je paket namenjen okviroma netstandard2.0 in netcoreapp2.0. Za več informacij o paketu NuGet glejte Microsoft.Dynamics.CustomerInsights.Api.

Dodajanje odjemalske knjižnice C# v projekt C#

  1. V Visual Studio odprite NuGet Upravitelja paketov za svoj projekt.

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

  3. Izberite Namesti da dodate paket v projekt.

    Druga možnost je, da zaženete ta ukaz v NuGet Konzoli upravitelja paketov: Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

Uporaba odjemalske knjižnice C#

  1. Uporabite Microsoft Authentication Library (MSAL) za pridobitev AccessToken uporabe obstoječe registracije aplikacije Azure.

  2. Po uspešnem preverjanju pristnosti in pridobitvi žetona sestavite novega ali uporabite obstoječega HttpClient z DefaultRequestHeaders "Authorization" nastavljenim na Nosilec "žeton za dostop" in Ocp-Apim-Subscription-Key nastavljen na naročniški ključ iz vašega Customer Insights - Data okolja.

    Po potrebi ponastavite glavo Authorization . Na primer, ko je žeton potekel.

  3. Prenesite to HttpClient v konstrukcijo CustomerInsights odjemalca.

  4. Opravite klice z odjemalcem na "razširitvene metode", na primer GetAllInstancesAsync. Če imate prednost dostop do osnovnega Microsoft.Rest.HttpOperationResponse , uporabite »metode sporočil http«, na primer GetAllInstancesWithHttpMessagesAsync.

  5. Odgovor je verjetno tip object , ker lahko metoda vrne več vrst (na primer IList<InstanceInfo> in ApiErrorResult). Če želite preveriti vrsto povratka, uporabite objekte v tipih odzivov, določenih na strani s podrobnostmi API-ja za to operacijo.

    Če potrebujete več informacij o zahtevi, uporabite metode sporočil http za dostop do neobdelanega objekta odgovora.

Paket NodeJS

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

Paket Python

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