Del via

Arbejde med Customer Insights - Data-API'er

  • Artikel

Dynamics 365 Customer Insights - Data leverer API'er til at opbygge dine egne applikationer baseret på dine data i Customer Insights. Oplysninger om disse API'er, der er angivet i API-referencen. De indeholder yderligere oplysninger om operationer, parametre og svar.

Bemærk

Customer Insights - Data-tabeller kan ikke aktiveres ved hjælp af Dataverse API'er. Det anbefales, at du bruger Dataverse API'er til at forespørge om Customer Insights-data, da de giver mere omfattende filtrering, større gennemløb og lavere ventetid. Du kan finde flere oplysninger i Dataverse API'er til Customer Insights.

Kom i gang med at prøve API'er

En administrator skal aktivere API-adgang til dine data. Når adgang er aktiveret, kan alle brugere bruge API'en sammen 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 konfigureret, skal du vælge Aktivér.

    Aktivering af API'er opretter en primær og sekundær abonnementsnøgle for dit miljø, der bruges i API-forespørgslerne. Du kan genoprette nøglerne ved at vælge Genopret primær eller Genopret sekundær under fanen API'er.

  4. Vælg Undersøg vores API'er for at afprøve API'er.

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

    Sådan testes API'er.

  6. Angiv værdien i rullemenuen Autorisation i sideruden til implicit. Authorization-overskriften tilføjes med ihændehavertoken. Din abonnementsnøgle udfyldes automatisk.

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

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

    HTTP-svaret vises nederst i ruden.

Opret en ny app-registrering på Azure-portalen

Opret en ny appregistrering for at bruge API'erne i et Azure-program ved hjælp af uddelegerede tilladelser.

  1. Fuldfør afsnittet Introduktion.

  2. Log på Azure-portalen med den konto, der har adgang til Customer Insights-data.

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

  4. Vælg Ny registrering, angiv et programnavn og vælg kontotype.

    Tilføj evt. en URL-adresse til omdirigering. http://localhost er tilstrækkelig til at udvikle et program på den lokale computer.

  5. Vælg Registrer.

  6. Gå til API-tilladelser på den nye app-registrering.

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

  8. Vælg Delegerede tilladelser under Tilladelsestype, og vælg derefter tilladelsen user_impersonation.

  9. Vælg Tilføj tilladelser.

  10. Vælg Tildel administratorsamtykke til... for at fuldføre app-registreringen.

  11. Hvis du har brug for at få adgang til API'en uden en bruger, kan du gå til Indstil server til server-programtilladelser.

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

Du kan finde oplysninger om brug af API'er i vores klientbiblioteker under Klientbiblioteker til Customer Insights.

Indstil server til server-programtilladelser

Opret en appregistrering, der ikke kræver brugerinteraktion og kan køres på en server.

  1. Gå til API-tilladelser i din app-registrering i Azure-portalen.

  2. Vælg Tilføj en tilladelse.

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

  4. Vælg Applikationstilladelser under Tilladelsestype, og vælg derefter tilladelsen api.access.

  5. Vælg Tilføj tilladelser.

  6. Gå tilbage til API-tilladelser for din app-registrering.

  7. Vælg Tildel administratorsamtykke til... for at fuldføre app-registreringen.

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

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

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

Eksempelforespørgsler

Vi har samlet en kort liste over OData-eksempelforespørgsler til arbejde med API'er under OData-forespørgselseksempler.

Customer Insights-klientbiblioteker

Kom i gang med at bruge de klientbiblioteker, der er tilgængelige til Customer Insights - Data-API'er. Alle bibliotekskildekoder og eksempelprogrammer findes i et GitHub-lager.

C# NuGet

Brug C# klientbiblioteker fra NuGet.org. Denne pakke er i øjeblikket rettet mod netstandard 2.0 og netcoreapp 2.0-strukturerne. Du kan finde flere oplysninger om NuGet-pakken i Microsoft.Dynamics.CustomerInsights.Api.

Tilføjelse af klientbiblioteket C# til et C#-projekt

  1. I Visual Studio skal du åbne NuGet-pakkestyring til dit projekt.

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

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

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

Brug af klientbiblioteket C#

  1. Brug Microsoft-godkendelsesbiblioteket (MSAL) til at hente en AccessToken ved hjælp af en eksisterende Azure-app-registrering.

  2. Når et token er godkendt og anskaffet korrekt, skal du oprette et nyt eller bruge et eksisterende HttpClient, hvor DefaultRequestHeaders "Authorization" er angivet til Bearer "adgangstoken" og Ocp-Apim-Subscription-Key er angivet til abonnementsnøglen fra dit Customer Insights - Data-miljø.

    Nulstil overskriften Godkendelse, hvis det er relevant. Når tokenet f. eks. er udløbet.

  3. Det skal overføres HttpClient til konstruktion af CustomerInsights-klienten.

  4. Foretag opkald med klienten i "udvidelsesmetoder" som f.eks. GetAllInstancesAsync. Hvis adgangen til den underliggende Microsoft.Rest.HttpOperationResponse er foretrukket, skal du bruge "http-meddelelsesmetoder" som f.eks. GetAllInstancesWithHttpMessagesAsync.

  5. Svaret vil sandsynligvis være typen object, 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-detaljer for den pågældende handling.

    Hvis der er behov for flere oplysninger om anmodningen, kan du bruge http-meddelelsesmetoderne til at få adgang til RAW-svarobjektet.

NodeJS-pakke

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

Python-pakke

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