Arbeide med kundeinnsikter – data-API-er

Dynamics 365 Customer Insights – Data gir API-er for å bygge dine egne programmer basert på dataene dine i Customer Insights. Du kan finne detaljer om disse API-ene i API-referansen, som inkluderer informasjon om operasjoner, parametere og svar.

Note

Customer Insights – Datatabeller kan også åpnes ved hjelp av dataverse API-er. Vi anbefaler at du bruker dataverse API-er til å spørre etter Kundeinnsikt-data ettersom de tilbyr mer omfattende filtrering, større gjennomstrømming og lavere ventetid. Hvis du vil ha mer informasjon, kan du se Dataverse API-er for Kundeinnsikter.

Kom i gang med å prøve API-ene

En administrator må aktivere API-tilgang til dataene dine. Når tilgang er aktivert, kan alle brukere bruke API med abonnementsnøkkelen.

  1. Logg på Customer Insights – Data eller registrer deg for en prøveversjon av Customer Insights.

  2. Gå tilInnstillinger-tillatelser>, og velg API-fanen.

  3. Hvis API-tilgang til miljøet ikke er satt opp, velg Aktiver.

    Når du aktiverer API-ene, oppretter du en primær og sekundær abonnementsnøkkel for miljøet ditt som du bruker i API-forespørslene. For å regenerere nøklene, velg Regenerate primary eller Regenerate secondary på API-fanen .

  4. Velg Utforsk API-ene våre for å prøve API-ene.

  5. Søk etter og velg en API-operasjon, og velg Prøv den.

    Skjermbilde av hvordan man tester API-ene.

  6. Angi verdien i rullegardinmenyen Autorisasjon til implisitt i sideruten. Toppteksten Authorization legges til med et bærertoken. Abonnementsnøkkelen din fylles automatisk ut.

  7. Du kan eventuelt legge til alle nødvendige spørringsparametere.

  8. Bla til bunnen av sideruten, og velg Send.

    HTTP-svaret vises nederst i ruten.

Opprette en ny appregistrering i Azure-portalen

Opprett en ny appregistrering for å bruke API-ene i en Azure-applikasjon ved å bruke delegerte tillatelser.

  1. Fullfør Kom i gang-delen.

  2. Logg på Azure-portalen med kontoen som har tilgang til Customer Insights-dataene.

  3. Søk etter, og velg deretter Appregistreringer.

  4. Velg Ny registrering, oppgi et applikasjonsnavn, og velg kontotype.

    Du kan også legge til en url-adresse for omadressering. http://localhost er tilstrekkelig til å utvikle et program på den lokale datamaskinen.

  5. Velg Registrer.

  6. På din nye app-registrering, gå til API-tillatelser.

  7. Velg Legg til en tillatelse , og velg Dynamics 365 AI for Customer Insights i sideruten.

  8. Velg Delegerte tillatelser for tillatelsestype, og velg deretter user_impersonation tillatelsen.

  9. Velg Legg til tillatelser.

  10. Velg Gi administratorsamtykke for... å fullføre appregistreringen.

  11. Hvis du vil ha tilgang til API-en uten at en bruker logger på, kan du gå til Angi server-til-server-programtillatelser.

Du kan bruke program-/klient-ID-en for denne appregistreringen med Microsoft Authentication Library (MSAL) til å hente et bærertoken som du kan sende med forespørselen din til API-en.

Hvis du vil ha informasjon om hvordan du bruker API-er i klientbibliotekene våre, kan du se Kundeinnsikt-klientbiblioteker.

Angi server-til-server-programtillatelser

Lag en appregistrering som ikke krever brukerinteraksjon og kan kjøres på en server.

  1. Gå til API-tillatelser på appregistreringen i Azure-portalen.

  2. Velg Legg til en tillatelse.

  3. Velg API-ene organisasjonen min bruker-fanen , og velg Dynamics 365 AI for Customer Insights fra listen.

  4. Velg programtillatelser for tillatelsestype, og velg deretter api.access-tillatelsen.

  5. Velg Legg til tillatelser.

  6. Gå tilbake til API-tillatelser for appregistreringen.

  7. Velg Gi administratorsamtykke for... å fullføre appregistreringen.

  8. Legg til navnet på appregistreringen som bruker i Customer Insights – Data.

    1. Åpne Kundeinnsikter – Data, gå tilInnstillinger-tillatelser> og velg Legg til brukere.

    2. Søk etter navnet på appregistreringen, velg det fra søkeresultatene, og velg Lagre.

Eksempelspørringer

Hvis du vil ha en kort liste over OData-eksempelspørringer som skal fungere med API-ene, kan du se eksempler på OData-spørringer.

Kundeinnsikter-klientbiblioteker

Kom i gang med klientbibliotekene som er tilgjengelige for Customer Insights – Data-API-er. Du kan finne all bibliotekets kildekode og eksempelapplikasjoner på et GitHub-repo.

C# NuGet

Bruk C#-klientbibliotekene fra NuGet.org. Pakken retter seg for øyeblikket mot netstandard2.0- og netcoreapp2.0-rammeverket. For mer informasjon om NuGet-pakken, se Microsoft.Dynamics. CustomerInsights.Api.

Legg til C#-klientbiblioteket i et C#-prosjekt

  1. Åpne NuGet Pakkebehandling for prosjektet i Visual Studio.

  2. Søk etter Microsoft.Dynamics.CustomerInsights.Api.

  3. Velg Installer for å legge til pakken i prosjektet.

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

Bruk C#-klientbiblioteket

  1. Bruk Microsoft Authentication Library (MSAL) for å få en AccessToken ved å bruke din eksisterende Azure-appregistrering.

  2. Etter at du har autentisert og fått en token, bygg en ny HttpClient eller bruk en eksisterende. Sett DefaultRequestHeaders "Authorization" til Bearer "access token" og sett Ocp-Apim-Subscription-Key til abonnementnøkkelen fra ditt Customer Insights - Data-miljø.

    Tilbakestill autorisasjonshodet når det er aktuelt. For eksempel når brikken utløper.

  3. Send dette HttpClient til konstruksjonen CustomerInsights av klienten.

  4. Foreta anrop med klienten til utvidelsesmetodene, for eksempel GetAllInstancesAsync. Hvis du foretrekker tilgang til det underliggende Microsoft.Rest.HttpOperationResponse, bruk "http message methods", for eksempel GetAllInstancesWithHttpMessagesAsync.

  5. Svaret er sannsynlig object type fordi metoden kan returnere flere typer (for eksempel IList<InstanceInfo> og ApiErrorResult). Hvis du vil kontrollere returtypen, bruker du objektene i svartypene som er angitt på API-detaljsiden for operasjonen.

    Hvis du trenger mer informasjon om forespørselen, bruk http-meldingsmetodene for å få tilgang til råresponsobjektet.

Node.js pakke

Bruk de Node.js klientbibliotekene som er tilgjengelige gjennom NPM: https://www.npmjs.com/package/@microsoft/customerinsights

Python-pakke

Bruk Python-klientbibliotekene som er tilgjengelige via PyPi: https://pypi.org/project/customerinsights/