Bendrinti naudojant

Darbas su „Customer Insights - Data“ API

  • Straipsnis

Dynamics 365 Customer Insights - Data teikia API, kad galėtumėte kurti savo programas pagal savo duomenis programoje "Customer Insights". Išsami informacija apie šias API pateikiama API nuorodoje. Jie apima papildomą informaciją apie operacijas, parametrus ir atsakymus.

Pastaba.

Customer Insights - Data lenteles taip pat galima pasiekti naudojant Dataverse API. Rekomenduojame naudoti Dataverse API užklausoms dėl "Customer Insights" duomenų, nes jie siūlo platesnį filtravimą, didesnį pralaidumą ir mažesnę delsą. Daugiau informacijos ieškokite Dataverse "Customer Insights" API.

Pradėkite išbandyti API

Administratorius turi įgalinti API prieigą prie jūsų duomenų. Įjungus prieigą, bet kuris vartotojas gali naudoti API su prenumeratos raktu.

  1. Customer Insights - Data Prisijunkite arba prisiregistruokite naudoti bandomąją "Customer Insights" versiją.

  2. Eikite į Nustatymų>leidimai ir pasirinkite skirtuką API .

  3. Jei API prieiga prie aplinkos nenustatyta, pasirinkite Įgalinti.

    Įgalinus API, sukuriamas pirminis ir antrinis jūsų aplinkos prenumeratos raktas, kuris naudojamas API užklausose. Norėdami atkurti raktus, skirtuke API pasirinkite Generuoti pirminį arba Generuoti antrinį .

  4. Pasirinkite Naršyti mūsų API , kad išbandytumėte API.

  5. Ieškokite ir pasirinkite API operaciją ir pasirinkite Išbandyti.

    Kaip išbandyti API.

  6. Šoninėje srityje išskleidžiamajame meniu Autorizacija nustatykite reikšmę į numanoma. Antraštė Authorization pridedama su nešėjo atpažinimo ženklu. Jūsų prenumeratos raktas užpildomas automatiškai.

  7. Pasirinktinai, įtraukite visus būtinus laukimo parametrus.

  8. Slinkite į šoninės srities apačią ir pasirinkite Siųsti.

    HTTP atsakymas rodomas srities apačioje.

Sukurkite naują programos registravimą „Azure“ portale

Sukurkite naują programos registraciją , kad galėtumėte naudoti API "Azure" programoje naudodami įgaliotuosius leidimus.

  1. Užbaikite skyrių Darbo pradžia.

  2. Prisijunkite prie "Azure" portalo naudodami paskyrą, kuri gali pasiekti "Customer Insights" duomenis.

  3. Ieškokite ir pasirinkite Programų registracijos.

  4. Pasirinkite Nauja registracija, nurodykite paraiškos pavadinimą ir pasirinkite paskyros tipą.

    Pasirinktinai įtraukite nukreipiantį URL. http://localhost pakanka sukurti programą vietiniame kompiuteryje.

  5. Pasirinkite Registruoti.

  6. Naujoje programos registracijoje eikite į API leidimai.

  7. Pasirinkite Įtraukti teisę ir šoninėje srityje pasirinkite Dynamics 365 AI for Customer Insights .

  8. Dalyje Teisių tipas pasirinkite Įgaliotosios teisės , tada pasirinkite user_impersonation teises.

  9. Pasirinkite Įtraukti teises.

  10. Pasirinkite Suteikti administratoriaus sutikimą ..., kad užbaigtumėte programos registraciją.

  11. Norėdami pasiekti API vartotojui neprisijungus, eikite į Nustatyti programos iš serverio į serverį teises.

Galite naudoti programos / kliento ID šiai programos registracijai "Microsoft" autentifikavimo bibliotekoje (MSAL), kad gautumėte turėtojo prieigos raktą, kurį siųsite kartu su užklausa į API.

Informacijos apie API naudojimą mūsų klientų bibliotekose ieškokite "Customer Insights" klientų bibliotekose.

Serverio-serverio taikomosios programos teisių nustatymas

Sukurkite programos registraciją, kuriai nereikia vartotojo sąveikos ir kurią galima paleisti serveryje.

  1. Programos registracijoje "Azure" portale eikite į API teises.

  2. Pasirinkite Pridėti leidimą.

  3. Pasirinkite skirtuką API, kurias naudoja mano organizacija, ir sąraše pasirinkite "Dynamics 365 AI for Customer Insights ".

  4. Dalyje Teisių tipas pasirinkite Programos teisės , tada pasirinkite teisę api.access .

  5. Pasirinkite Įtraukti teises.

  6. Grįžkite prie programos registracijos API leidimų .

  7. Pasirinkite Suteikti administratoriaus sutikimą ..., kad užbaigtumėte programos registraciją.

  8. Įtraukite programos registracijos pavadinimą kaip naudotoją Customer Insights - Data.

    1. Atidarykite Customer Insights - Data, eikite į Nustatymų leidimai ir pasirinkite>Pridėti vartotojų.

    2. Ieškokite programos registracijos pavadinimo, pasirinkite jį iš paieškos rezultatų ir pasirinkite Įrašyti.

Užklausų pavyzdžiai

Trumpą "OData" užklausų pavyzdžių, skirtų dirbti su API, sąrašą rasite "OData" užklausų pavyzdžiuose.

„Customer Insights“ kliento bibliotekos

Pradėkite naudoti klientų bibliotekas, Customer Insights - Data prieinamas API. Visus bibliotekos šaltinio kodus ir programų pavyzdžius galite rasti "GitHub" atpirkimo sandoryje.

C# NuGet

Naudokite C# klientų bibliotekas iš.org NuGet. Šiuo metu paketas skirtas netstandard2.0 ir netcoreapp2.0 sistemoms. Daugiau informacijos apie NuGet paketą rasite Microsoft.Dynamics.CustomerInsights.Api.

Įtraukite C# kliento biblioteką į C# projektą

  1. Į Visual Studio, atidarykite NuGet savo projekto paketų tvarkyklę .

  2. Ieškokite Microsoft.Dynamics.CustomerInsights.API.

  3. Pasirinkite Įdiegti , kad įtrauktumėte paketą į projektą.

    Arba paleiskite šią komandą paketų tvarkyklės konsolėje NuGet : Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

Naudokite C# kliento biblioteką

  1. Naudokite "Microsoft" autentifikavimo biblioteką (MSAL), kad gautumėte esamos AccessToken "Azure" programos registraciją.

  2. Sėkmingai autentifikavę ir įsigiję atpažinimo ženklą, sukurkite naują arba naudokite esamą HttpClient su DefaultRequestHeaders "Autorizacija", nustatyta kaip Turėtojo "prieigos žetonas", ir Ocp-Apim-Subscription-Key , nustatytą prenumeratos raktui iš jūsų Customer Insights - Data aplinkos.

    Jei reikia, iš naujo nustatykite autorizacijos antraštę. Pavyzdžiui, kai žyma baigė galioti.

  3. Perduokite tai HttpClient kliento statybai CustomerInsights .

  4. Pavyzdžiui, GetAllInstancesAsync skambinkite su klientu į "pratęsimo metodus". Jei pageidaujama prieiga prie pagrindo Microsoft.Rest.HttpOperationResponse , naudokite, pavyzdžiui GetAllInstancesWithHttpMessagesAsync, "http pranešimo metodus".

  5. Tikėtinas object atsakymo tipas, nes metodas gali pateikti kelis tipus (pvz., ir IList<InstanceInfo> ). ApiErrorResult Norėdami patikrinti grąžinimo tipą, naudokite objektus atsakymų tipuose, nurodytuose API išsamios informacijos puslapyje tai operacijai.

    Jei reikia daugiau informacijos apie užklausą, naudokite http pranešimo metodus , kad pasiektumėte neapdoroto atsakymo objektą.

„NodeJS” paketas

Naudokite NodeJS klientų bibliotekas, pasiekiamas per NPM: https://www.npmjs.com/package/@microsoft/customerinsights

„Python” paketas

Naudokite Python klientų bibliotekas, pasiekiamas per PyPi: https://pypi.org/project/customerinsights/