Zdieľať cez

Práca s rozhraniami API aplikácie Customer Insights - Data

  • Článok

Dynamics 365 Customer Insights - Data poskytuje API na vytváranie vlastných aplikácií na základe vašich údajov v Customer Insights. Podrobnosti o týchto rozhraniach API sú uvedené v referencii API. Patria sem dodatočné informácie o operáciách, parametroch a reakciách.

Poznámka

Customer Insights - Data k tabuľkám je možné pristupovať aj pomocou Dataverse API. Odporúčame vám použiť Dataverse API na dopytovanie údajov Customer Insights, pretože ponúkajú rozsiahlejšie filtrovanie, vyššiu priepustnosť a nižšiu latenciu. Ďalšie informácie nájdete v časti Dataverse API for Customer Insights.

Začnite skúšať rozhrania API

Správca musí povoliť API prístup k vašim údajom. Po povolení prístupu môže každý používateľ používať API s kľúčom predplatného.

  1. prihláste sa na Customer Insights - Data alebo zaregistrujte sa na odber skúšobnej verzie Customer Insights.

  2. Prejdite na Nastavenia>Povolenia a vyberte kartu API .

  3. Ak nebol nastavený prístup API k prostrediu, vyberte Povoliť.

    Povolenie rozhraní API vytvorí primárny a sekundárny kľúč predplatného pre vaše prostredie, ktorý sa používa v požiadavkách API. Ak chcete znova vygenerovať kľúče, vyberte možnosť Regenerovať primárne alebo Regenerovať sekundárne v API .

  4. Vyberte Preskúmať naše rozhrania API a vyskúšajte rozhrania API.

  5. Vyhľadajte a vyberte operáciu API a vyberte Vyskúšať.

    Ako testovať API.

  6. Na bočnom paneli nastavte hodnotu v rozbaľovacej ponuke Autorizácia na implicitné. Do hlavičky Authorization sa pridá token nosiča. Váš predplatiteľský kľúč sa vyplní automaticky.

  7. Prípadne môžete pridať všetky potrebné parametre dotazu.

  8. Prejdite na spodok bočného panela a vyberte Odoslať.

    Odpoveď HTTP sa zobrazí v spodnej časti tably.

Vytvorte novú registráciu aplikácie na portáli Azure

Vytvorte novú registráciu aplikácie na používanie rozhraní API v aplikácii Azure pomocou delegovaných povolení.

  1. Vyplňte sekciu Začíname.

  2. Prihláste sa na portál Azure s účtom, ktorý má prístup k údajom Customer Insights.

  3. Vyhľadajte a potom vyberte Registrácie aplikácií.

  4. Vyberte Nová registrácia, zadajte názov aplikácie a vyberte typ účtu.

    Prípadne pridajte adresu URL presmerovania. http://localhost postačuje na vývoj aplikácie na vašom lokálnom počítači.

  5. Vyberte položku Registrovať.

  6. Pri registrácii novej aplikácie prejdite na Povolenia rozhrania API.

  7. Vyberte Pridať povolenie a na bočnom paneli vyberte Dynamics 365 AI pre Customer Insights .

  8. Pre Typ povolenia vyberte Delegované povolenia a potom vyberte odcudzenie identity používateľa povolenie.

  9. Vyberte položku Pridať povolenia.

  10. Ak chcete dokončiť registráciu aplikácie, vyberte možnosť Udeliť súhlas správcu pre... .

  11. Ak chcete získať prístup k rozhraniu API bez prihlásenia používateľa, prejdite na Nastavenie povolení aplikácie server-to-server.

ID aplikácie/klienta na registráciu tejto aplikácie môžete použiť v knižnici Microsoft Authentication Library (MSAL) na získanie tokenu nosiča, ktorý sa odošle s vašou žiadosťou do rozhrania API.

Informácie o používaní rozhraní API v našich klientskych knižniciach nájdete v časti Klientské knižnice Customer Insights.

Nastavte povolenia aplikácie server-to-server

Vytvorte registráciu aplikácie, ktorá nevyžaduje interakciu používateľa a možno ju spustiť na serveri.

  1. Pri registrácii aplikácie na portáli Azure prejdite na Povolenia rozhrania API.

  2. Vyberte Pridať povolenie.

  3. Vyberte kartu API, ktorú moja organizácia používa a zo zoznamu vyberte Dynamics 365 AI for Customer Insights .

  4. Pre Typ povolenia vyberte Povolenia aplikácie a potom vyberte api.access povolenie.

  5. Vyberte položku Pridať povolenia.

  6. Vráťte sa na Povolenia rozhrania API na registráciu aplikácie.

  7. Ak chcete dokončiť registráciu aplikácie, vyberte možnosť Udeliť súhlas správcu pre... .

  8. Pridajte názov registrácie aplikácie ako používateľa do Customer Insights - Data.

    1. Otvorte Customer Insights - Data, prejdite na Nastavenia>Povolenia a vyberte Pridať používateľov.

    2. Vyhľadajte názov svojej registrácie aplikácie, vyberte ju z výsledkov vyhľadávania a vyberte Uložiť.

Vzorové otázky

Krátky zoznam vzorových dotazov OData na prácu s rozhraniami API nájdete v časti Príklady dotazov OData.

Knižnice klientov v službe Customer Insights

Začnite používať klientske knižnice dostupné pre Customer Insights - Data API. Všetok zdrojový kód knižnice a vzorové aplikácie možno nájsť na repo GitHub.

C# NuGet

Použite klientske knižnice C# z NuGet.org. V súčasnosti sa balík zameriava na rámce netstandard2.0 a netcoreapp2.0. Ďalšie informácie o balíku NuGet nájdete v časti Microsoft.Dynamics.CustomerInsights.Api.

Pridajte knižnicu klientov C# do projektu C#

  1. V Visual Studio otvorte NuGet Správcu balíkov pre svoj projekt.

  2. Vyhľadajte Microsoft.Dynamics.CustomerInsights.Api.

  3. Výberom možnosti Inštalovať pridáte balík do projektu.

    Prípadne spustite tento príkaz v NuGet Konzole správcu balíkov: Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

Použite knižnicu klientov C#

  1. Použite Microsoft Authentication Library (MSAL) a získajte AccessToken pomocou existujúcej registrácie aplikácie Azure.

  2. Po úspešnom overení a získaní tokenu vytvorte nový alebo použite existujúci HttpClient s DefaultRequestHeaders "Autorizácia" nastaveným na Prístupový token nosiča a Ocp-Apim-Subscription-Key nastavené na kľúč predplatného z vášho Customer Insights - Data prostredia.

    V prípade potreby obnovte hlavičku Autorizácia . Napríklad ak vypršala platnosť tokenu.

  3. Preneste to HttpClient do konštrukcie CustomerInsights klienta.

  4. Uskutočnite hovory s klientom na "metódy rozšírenia", napríklad GetAllInstancesAsync. Ak preferujete prístup k podkladu Microsoft.Rest.HttpOperationResponse , použite "metódy správy http", napríklad GetAllInstancesWithHttpMessagesAsync.

  5. Odpoveď je pravdepodobne typu object , pretože metóda môže vrátiť viacero typov (napríklad IList<InstanceInfo> a ApiErrorResult). Ak chcete skontrolovať návratový typ, použite objekty v typoch odpovedí špecifikovaných na stránke podrobností o rozhraní API pre danú operáciu.

    Ak sú potrebné ďalšie informácie o požiadavke, použite metódy správy http na prístup k nespracovanému objektu odpovede.

Balíček NodeJS

Použite klientske knižnice NodeJS dostupné cez NPM: https://www.npmjs.com/package/@microsoft/customerinsights

Balík Python

Použite klientske knižnice Pythonu dostupné cez PyPi: https://pypi.org/project/customerinsights/