Delo z API-ji za Customer Insights - Data

  • Članek

Dynamics 365 Customer Insights - Data ponuja API-je za ustvarjanje lastnih aplikacij na podlagi vaših podatkov v Customer Insights. Podrobnosti o teh API-jih so navedene v referenci API. Vključujejo dodatne informacije o postopkih, parametrih in odzivih.

opomba,

Customer Insights - Data do tabel lahko dostopate tudi z Dataverse API-ji. Priporočamo, da uporabite Dataverse API-je za poizvedovanje po podatkih Customer Insights, saj ponujajo obsežnejše filtriranje, večjo prepustnost in nižjo zakasnitev. Za več informacij glejte Dataverse API-ji za Customer Insights.

Začnite preizkušati API-je

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

  1. prijavite se da se Customer Insights - Data ali prijavite za preizkusno različico Customer Insights.

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

  3. Če API dostop 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-jev. Za ponovno generiranje ključev izberite Regeneriraj primarni ali Regeneriraj sekundarni na API-jih zavihek.

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

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

    Kako testirati API-je.

  6. V stranskem podoknu nastavite vrednost v spustnem meniju Pooblastilo na implicitno. Glava Authorization se doda z žetonom nosilca. Vaš 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.

    Odgovor 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 delegiranimi dovoljenji.

  1. Izpolnite razdelek Kako začeti.

  2. Prijavite se na portal Azure z računom, ki lahko dostopa do podatkov 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 registraciji nove aplikacije pojdite na Dovoljenja API-ja.

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

  8. Za Vrsto dovoljenja izberite Delegirana dovoljenja in nato izberite user_impersonation dovoljenje.

  9. Izberite Dodaj dovoljenja.

  10. Izberite Podari skrbniško soglasje za... za dokončanje registracije aplikacije.

  11. Za dostop do API-ja, ne da bi se uporabnik prijavil, pojdite na Nastavitev dovoljenj za aplikacije med strežniki.

Uporabite lahko ID aplikacije/odjemalca za to registracijo aplikacije z Microsoft Authentication Library (MSAL) za pridobitev žetona nosilca, ki ga pošljete z vašo zahtevo v API.

Za informacije o uporabi API-jev v naših odjemalskih knjižnicah glejte Knjižnice odjemalcev Customer Insights.

Nastavite dovoljenja za aplikacije med strežniki

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

  1. Pri registraciji aplikacije na portalu Azure pojdite na Dovoljenja API-ja.

  2. Izberite Dodaj dovoljenje.

  3. Izberite zavihek API-ji, ki jih uporablja moja organizacija in izberite Dynamics 365 AI for Customer Insights s seznama.

  4. Za Vrsto dovoljenja izberite Dovoljenja za aplikacije in nato izberite api.access dovoljenje.

  5. Izberite Dodaj dovoljenja.

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

  7. Izberite Podari skrbniško soglasje za... za dokončanje registracije aplikacije.

  8. Dodajte ime aplikacije za registracijo kot uporabnik 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# z 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 nastavljena 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, ki so določeni 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/