Бөлісу құралы:

Customer Insights - Data API интерфейстерімен жұмыс істеу

  • Мақала

Dynamics 365 Customer Insights - Data Customer Insights ішіндегі деректеріңізге негізделген жеке қолданбаларды құру үшін API интерфейстерін ұсынады. Бұл API мәліметтері API анықтамасында берілген. Олар операциялар, параметрлер және жауаптар туралы қосымша ақпаратты қамтиды.

Ескертпе

Customer Insights - Data кестелерге Dataverse API арқылы қол жеткізуге болады. Customer Insights деректерін сұрау үшін Dataverse API пайдалануды ұсынамыз, себебі олар кеңірек сүзгілеуді, үлкен өткізу қабілетін және аз кідірісті ұсынады. Қосымша ақпарат алу үшін, Customer Insights үшін Dataverse API мекенжайларын қараңыз.

API интерфейстерін қолданып көріңіз

Әкімші деректеріңізге API қатынасын қосуы керек. Қол жеткізу қосылғаннан кейін кез келген пайдаланушы жазылым кілтімен API пайдалана алады.

  1. Жүйеге Customer Insights - Data немесе Cusser Insights қолданбасының сынақ нұсқасына тіркелу үшін кіріңіз.

  2. Параметрлер>Рұқсаттар тармағына өтіп, API қойындысын таңдаңыз.

  3. Ортаға API қатынасы орнатылмаған болса, Қосу таңдаңыз.

    API интерфейстерін қосу API сұрауларында пайдаланылатын ортаңыз үшін негізгі және қосымша жазылым кілтін жасайды. Пернелерді қалпына келтіру үшін API интерфейстерінде Негізгі қалпына келтіру немесе Қосымша қалпына келтіру таңдаңыз. қойындысы.

  4. API интерфейстерін сынап көру үшін API интерфейстерін зерттеңіз таңдаңыз.

  5. API операциясын іздеңіз және таңдаңыз және Оны қолданып көру таңдаңыз.

    API интерфейстерін қалай тексеруге болады.

  6. Бүйірлік тақтада Авторизация ашылмалы мәзірдегі мәнді толық етіп орнатыңыз. Authorization тақырып тасымалдаушы белгісімен қосылады. Жазылым кілті автоматты түрде толтырылады.

  7. Оған қоса, қажетті барлық сұрау параметрлерін қосыңыз.

  8. Бүйірлік тақтаның төменгі жағына жылжып, Жіберу таңдаңыз.

    HTTP жауабы тақтаның төменгі жағында көрсетіледі.

Azure порталында жаңа бағдарлама тіркелімін жасаңыз

Өкілдік берілген рұқсаттарды пайдаланып, Azure қолданбасында API интерфейстерін пайдалану үшін жаңа қолданбаны тіркеу жасыңыз.

  1. Бастау бөлімін аяқтаңыз.

  2. Customer Insights деректеріне қол жеткізе алатын тіркелгімен Azure порталына кіріңіз.

  3. Қолданбаларды тіркеу деп іздеп, таңдаңыз.

  4. Жаңа тіркеу таңдаңыз, қолданба атын беріңіз және тіркелгі түрін таңдаңыз.

    Оған қоса, URL мекенжайын бағыттауды қосыңыз. http://localhost жергілікті компьютерде қолданбаны әзірлеу үшін жеткілікті.

  5. Тіркеу опциясын таңдаңыз.

  6. Жаңа қолданбаны тіркеу кезінде API рұқсаттары бөліміне өтіңіз.

  7. Рұқсат қосу және бүйірлік тақтада Dynamics 365 AI for Customer Insights таңдаңыз.

  8. Рұқсат түрі үшін Өкілетті рұқсаттарды таңдаңыз, содан кейін пайдаланушының еліктеуін таңдаңыз. рұқсат.

  9. Рұқсаттарды қосу опциясын таңдаңыз.

  10. Қолданбаны тіркеуді аяқтау үшін Әкімші келісімін беру... пәрменін таңдаңыз.

  11. API интерфейсіне пайдаланушы кірместен қол жеткізу үшін Серверден серверге қолданба рұқсаттарын орнату бөліміне өтіңіз.

Осы қолданбаны тіркеу үшін Қолданбаны/Клиент идентификаторын Microsoft Authentication Library (MSAL) арқылы API-ге сұрауыңызбен жіберу үшін тасымалдаушы таңбалауышын алуға болады.

Клиенттік кітапханаларымызда API интерфейстерін пайдалану туралы ақпаратты Customer Insights клиент кітапханалары бөлімінен қараңыз.

Серверден серверге қолданба рұқсаттарын орнатыңыз

Пайдаланушы әрекетін қажет етпейтін және серверде іске қосуға болатын қолданбаны тіркеуді жасаңыз.

  1. Azure порталында қолданбаны тіркеуде API рұқсаттары бөліміне өтіңіз.

  2. Рұқсат қосу таңдаңыз.

  3. Менің ұйымым пайдаланатын API қойындысын таңдап, тізімнен Dynamics 365 AI for Customer Insights таңдаңыз.

  4. Рұқсат түрі үшін Қолданба рұқсаттары таңдап, api.access рұқсатын таңдаңыз.

  5. Рұқсаттарды қосу опциясын таңдаңыз.

  6. Қолданбаны тіркеу үшін API рұқсаттарына қайта оралыңыз.

  7. Қолданбаны тіркеуді аяқтау үшін Әкімші келісімін беру... пәрменін таңдаңыз.

  8. Қолданбаны пайдаланушы ретінде тіркеу атауын Customer Insights - Data ішіне қосыңыз.

    1. Customer Insights - Dataашыңыз, Параметрлер>Рұқсаттар тармағына өтіп, Пайдаланушыларды қосу опциясын таңдаңыз.

    2. Қолданбаны тіркеу атауын іздеңіз, оны іздеу нәтижелерінен таңдап, Сақтау пәрменін таңдаңыз.

Сұрау үлгісі

API интерфейстерімен жұмыс істеуге арналған OData үлгі сұрауларының қысқаша тізімін OData сұрау мысалдары қараңыз.

Customer Insights клиенттік кітапханалары

Customer Insights - Data API үшін қолжетімді клиент кітапханаларын пайдалануды бастаңыз. Кітапхананың барлық бастапқы кодын және үлгі қолданбаларды GitHub репо сайтынан табуға болады.

C# NuGet

NuGet.org сайтындағы C# клиент кітапханаларын пайдаланыңыз. Қазіргі уақытта бума netstandard2.0 және netcoreapp2.0 жақтауларына бағытталған. NuGet бума туралы қосымша ақпаратты Microsoft.Dynamics.CustomerInsights.Api қараңыз.

C# жобасына C# клиенттік кітапханасын қосыңыз

  1. Visual Studioішінде жобаңыз үшін NuGet Package Manager ашыңыз.

  2. Microsoft.Dynamics.CustomerInsights.Api іздеңіз.

  3. Буманы жобаға қосу үшін Орнату тармағын таңдаңыз.

    Немесе, осы пәрменді NuGet Package Manager Console ішінде іске қосыңыз: Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

C# клиенттік кітапханасын пайдаланыңыз

  1. Қолданыстағы Azure қолданбасын тіркеу арқылы AccessToken алу үшін Microsoft Authentication Library (MSAL) пайдаланыңыз.

  2. Сәтті аутентификация және таңбалауыш алғаннан кейін, жаңасын жасаңыз немесе бар HttpClient қолданыңыз DefaultRequestHeaders "Авторизация" Тасымалдаушы "қолжетімділік белгісі" және Ocp-Apim-жазылым кілті жазылым кілтіне орнатылған Customer Insights - Data ортаңыздан.

    Қажет болған жағдайда Рұқсат ету тақырыбын қалпына келтіріңіз. Мысалы, таңбалауыш мерзімі аяқталған кезде.

  3. Мұны HttpClient клиенттің CustomerInsights құрылымына өткізіңіз.

  4. Клиентпен «кеңейтім әдістеріне» қоңырау шалыңыз, мысалы, GetAllInstancesAsync. Егер негізгі Microsoft.Rest.HttpOperationResponse қажеттілік қажет болса, "http хабар әдістерін" пайдаланыңыз, мысалы, GetAllInstancesWithHttpMessagesAsync.

  5. Жауап object түрі болуы мүмкін, себебі әдіс бірнеше түрді қайтара алады (мысалы, IList<InstanceInfo> және ApiErrorResult). Қайтару түрін тексеру үшін сол операция үшін API мәліметтері бетінде көрсетілген жауап түрлеріндегі нысандарды пайдаланыңыз.

    Сұрау туралы қосымша ақпарат қажет болса, өңделмеген жауап нысанына кіру үшін http хабар әдістерін пайдаланыңыз.

NodeJS бумасы

NPM арқылы қол жетімді NodeJS клиенттік кітапханаларын пайдаланыңыз: https://www.npmjs.com/package/@microsoft/customerinsights

Python бумасы

PyPi арқылы қол жетімді Python клиенттік кітапханаларын пайдаланыңыз: https://pypi.org/project/customerinsights/