Arbejd med Customer Insights – Data-API'er

Dynamics 365 Customer Insights – Data leverer API'er til at bygge dine egne programmer baseret på dine data i Customer Insights. Du kan finde detaljer om disse API'er i API-referencen, som inkluderer information om operationer, parametre og svar.

Notat

Customer Insights – Du kan også få adgang til datatabeller ved hjælp af Dataverse-API'er. Vi anbefaler, at du bruger Dataverse-API'er til at forespørge kundeindsigtsdata, da de giver mere omfattende filtrering, større dataoverførselshastighed og lavere ventetid. Du kan få flere oplysninger under Dataverse API'er til Kundeindsigt.

Kom i gang med at prøve API'erne

En administrator skal aktivere API-adgang til dine data. Når adgang er aktiveret, kan alle brugere bruge API med abonnementsnøglen.

  1. Log på Customer Insights – Data, eller tilmeld dig en prøveversion af Customer Insights.

  2. Gå til Indstillinger>Tilladelser, og vælg fanen API'er .

  3. Hvis API-adgang til miljøet ikke er sat op, vælg Aktiver.

    Når du aktiverer API'erne, opretter du en primær og sekundær abonnementsnøgle til dit miljø, som du bruger i API-anmodningerne. For at gengenerere nøglerne skal du vælge Regenerate primær eller Regenerate sekundær på API-fanen .

  4. Vælg Udforsk vores API'er for at afprøve API'erne.

  5. Søg efter og vælg en API-handling, og vælg Prøv det.

    Skærmbillede af, hvordan man tester API'erne.

  6. I sideruden skal du angive værdien i rullemenuen Godkendelse til implicit. Overskriften Authorization tilføjes med et ihændehavertoken. Din abonnementsnøgle udfyldes automatisk.

  7. Du kan også tilføje alle nødvendige forespørgselsparametre.

  8. Rul til bunden af sideruden, og vælg Send.

    HTTP-svaret vises nederst i ruden.

Opret en ny appregistrering på Azure Portal

Opret en ny app-registrering til at bruge API'erne i en Azure-applikation ved at bruge delegerede tilladelser.

  1. Fuldfør afsnittet Introduktion.

  2. Log på Azure Portal med den konto, der kan få adgang til Customer Insights-dataene.

  3. Søg efter, og vælg derefter Appregistreringer.

  4. Vælg Ny registrering, angiv et ansøgningsnavn, og vælg kontotypen.

    Du kan også tilføje en URL-adresse til omdirigering. http://localhost er tilstrækkeligt til at udvikle et program på din lokale computer.

  5. Vælg Registrer.

  6. Ved din nye app-registrering skal du gå til API-tilladelser.

  7. Vælg Tilføj en tilladelse, og vælg Dynamics 365 AI for Customer Insights i sideruden.

  8. For Tilladelsestype skal du vælge Delegerede tilladelser og derefter vælge tilladelsen user_impersonation .

  9. Vælg Tilføj tilladelser.

  10. Vælg Giv administratorsamtykke for... for at fuldføre appregistreringen.

  11. Hvis du vil have adgang til API'en, uden at en bruger logger på, skal du gå til Angiv tilladelser for server-til-server-programmer.

Du kan bruge program-/klient-id'et til denne appregistrering med Microsoft Authentication Library (MSAL) til at hente et ihændehavertoken, der skal sendes sammen med din anmodning til API'en.

Du kan få oplysninger om brug af API'er i vores klientbiblioteker under Kundeindsigt-klientbiblioteker.

Angiv tilladelser for server-til-server-programmer

Opret en app-registrering, der ikke kræver brugerinteraktion og kan køre på en server.

  1. Gå til API-tilladelser i din appregistrering på Azure Portal.

  2. Vælg Tilføj en tilladelse.

  3. Vælg fanen API'er, som min organisation bruger , og vælg Dynamics 365 AI for Customer Insights på listen.

  4. For Tilladelsestype skal du vælge Programtilladelser og derefter vælge tilladelsen api.access .

  5. Vælg Tilføj tilladelser.

  6. Gå tilbage til API-tilladelser til din appregistrering.

  7. Vælg Giv administratorsamtykke for... for at fuldføre appregistreringen.

  8. Tilføj navnet på appregistreringen som bruger i Customer Insights – Data.

    1. Åbn Kundeindsigt – Data, gå til Indstillinger>Tilladelser, og vælg Tilføj brugere.

    2. Søg efter navnet på din appregistrering, vælg det i søgeresultaterne, og vælg Gem.

Eksempelforespørgsler

Du kan se en kort liste over OData-eksempelforespørgsler, der skal arbejde med API'er, i eksempler på OData-forespørgsler.

Kundeindsigtsklientbiblioteker

Kom i gang med at bruge de klientbiblioteker, der er tilgængelige for Customer Insights – Data-API'er. Du kan finde al bibliotekets kildekode og eksempelapplikationer på et GitHub-repo.

C# NuGet

Brug C#-klientbibliotekerne fra NuGet.org. I øjeblikket er pakken målrettet netstandard2.0- og netcoreapp2.0-frameworks. For mere information om NuGet-pakken, se Microsoft.Dynamics. CustomerInsights.Api.

Føj klientbiblioteket C# til et C#-projekt

  1. Åbn NuGet Pakkestyring for dit projekt i Visual Studio.

  2. Søg efter Microsoft.Dynamics.CustomerInsights.Api.

  3. Vælg Installér for at føje pakken til projektet.

    Du kan også køre denne kommando i NuGet Pakkestyring-konsollen: Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

Brug C#-klientbiblioteket

  1. Brug Microsoft Authentication Library (MSAL) for at få en AccessToken ved at bruge din eksisterende Azure-app-registrering.

  2. Når du har autentificeret og erhvervet et token, skal du bygge et nyt HttpClient eller bruge et eksisterende. Sæt DefaultRequestHeaders "Authorization" til Bearer "access token" og sæt Ocp-Apim-Subscription-Key til abonnementnøglen fra dit Customer Insights - Data-miljø.

    Nulstil godkendelsesheaderen , når det er relevant. For eksempel når tokenet udløber.

  3. Overfør dette HttpClient til klientens CustomerInsights konstruktion.

  4. Foretag opkald ved hjælp af klienten til "udvidelsesmetoderne", for eksempel GetAllInstancesAsync. Hvis du foretrækker adgang til det underliggende Microsoft.Rest.HttpOperationResponse, brug "http message methods", for eksempel GetAllInstancesWithHttpMessagesAsync.

  5. Svaret er sandsynligvis object type, fordi metoden kan returnere flere typer (f.eks. IList<InstanceInfo> og ApiErrorResult). Hvis du vil kontrollere returtypen, skal du bruge objekterne i de svartyper, der er angivet på siden med API-oplysninger for den pågældende handling.

    Hvis du har brug for mere information om forespørgslen, brug http-beskedmetoderne til at få adgang til det rå svarobjekt.

Node.js pakke

Brug de Node.js klientbiblioteker, der er tilgængelige gennem NPM: https://www.npmjs.com/package/@microsoft/customerinsights

Python-pakke

Brug de Python-klientbiblioteker, der er tilgængelige via PyPi: https://pypi.org/project/customerinsights/