Arbeta med Customer Insights - Data API:er

Dynamics 365 Customer Insights - Data tillhandahåller API:er för att bygga egna program baserat på dina data i Customer Insights. Detaljer om dessa API:er anges i API-referens. De innehåller ytterligare information om operationer, parametrar och svar.

Kommentar

Customer Insights - Data-tabeller kan också nås med hjälp av Dataverse API:er. Vi rekommenderar att du använder Dataverse API:er för att fråga efter Customer Insights-data eftersom de erbjuder mer omfattande filtrering, större genomflöde och lägre prestanda. Mer information finns i Dataverse API:er för Customer Insights.

Kom igång med att prova API:erna

En administratör måste aktivera API-åtkomst till dina data. När åtkomsten har aktiverats kan alla användare använda API med prenumerationsnyckeln.

1. Logga in på Customer Insights - Data eller registrera dig för en provversion av Customer Insights.

2. Gå till Inställningar>Behörigheter och välj fliken API:er.

3. Om API-åtkomst till miljön inte har konfigurerats väljer du Aktivera.

   Att aktivera API:erna skapar en primär och sekundär prenumerationsnyckel för din miljö som används i API-begäranden. För att återskapa nycklarna, välj Återskapa primärt eller Återskapa sekundär på fliken API:er.

4. Välj Utforska våra API:er för att testa API:erna.

5. Sök efter och välj en API-åtgärd och välj Prova.

   

6. I sidpanelen anger du värdet för listrutan Auktorisering till implicit. Sidhuvudet Authorization läggs till med en ägartoken. Din prenumerationsnyckel kommer att fyllas i automatiskt.

7. Lägg alternativt till alla nödvändiga frågeparametrar.

8. Rulla längst ned i sidorutan och välj Skicka.

   HTTP-svaret kommer att visas längst ned på rutan:

Skapa en ny appregistrering i Azure-portalen

Skapa en ny appregistrering för att använda API:er i ett Azure-program med delegerade behörigheter.

1. Slutför avsnittet Komma igång.

2. Logga in på Azure-portalen med det konto som kan komma åt Customer Insights-data.

3. Sök efter och markera Appregistreringar.

4. Välj Ny registrering, tillhandahåll ett programnamn och välj kontotyp.

   Lägg alternativt till en omdirigerings-URL. http://localhost är tillräcklig för att utveckla ett program på din lokala dator.

5. Välj Registrera.

6. På din nya App-registrering går du till API-behörigheter.

7. Välj Lägg till en behörighet och välj Dynamics 365 AI för Customer Insights i sidofönstret.

8. För Behörighetstyp väljer du Delegerad behörighet och sedan behörigheten användarpersonifiering.

9. Välj Lägg till behörigheter.

10. Välj Bevilja admin-godkännande för... för att slutföra registreringen av appen.

11. För att komma åt API:et utan att en användare loggar in, gå till Server-till-server-programbehörigheter.

Du kan använda Program-/klient-ID för den här appregistreringen med Microsoft Authentication Library (MSAL) för att få ett ägartoken att skicka med din begäran till API:et.

Information om hur du använder API:er i våra klientbibliotek finns i Customer Insights-klientbibliotek.

Ange programbehörigheter för server till server

Skapa en appregistrering som inte behöver användarinteraktion och som kan köras på en server.

1. På din app-registrering i Azure Portal går du till API-behörigheter.

2. Välj Lägg till behörighet.

3. Välj fliken API:er som min organisation använder och välj Dynamics 365 AI för Customer Insights från listan.

4. För Behörighetstyp väljer du Programbehörighet och sedan behörigheten api.access.

5. Välj Lägg till behörigheter.

6. Gå tillbaka till API-behörigheter för din app-registrering.

7. Välj Bevilja admin-godkännande för... för att slutföra registreringen av appen.

8. Lägg till namnet på appregistreringen som en användare i Customer Insights - Data.

   1. Öppna Customer Insights - Data, gå till Inställningar>Behörigheter och välj Lägg till användare.

   2. Sök efter namnet på din appregistrering, välj den bland sökresultaten och välj Spara.

Exempelfrågor

För en kort lista med OData-exempelfrågor som fungerar med API:er, se Exempel på OData-frågor.

Klientbibliotek för Customer Insights

Komma igång med de tillgängliga klientbiblioteken för Customer Insights - Data API:erna. All bibliotekskällkod och alla exempelprogram finns på sidan GitHub-lagringsplats.

C# NuGet

Använd C#-klientbiblioteken från NuGet.org. För närvarande riktar detta paket in sig på ramverken netstandard2.0 och netcoreapp2.0. Mer information om NuGet paketet finns i Microsoft.Dynamics.CustomerInsights.Api.

Lägga till C#-klientbiblioteket i ett C#-projekt

1. I Visual Studio öppnar du NuGet-pakethanteraren för ditt projekt.

2. Sök efter Microsoft.Dynamics.CustomerInsights.Api.

3. Välj Installera för att lägga till paketet i projektet.

   Alternativt kan du köra det här kommandot i pakethanterarkonsolen för NuGet: Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

Använda klientbiblioteket C#

1. Använd Microsoft Authentication Library (MSAL) för att få ett AccessToken med hjälp av din befintliga Azure-appregistrering.

2. Efter att ha lyckats autentisera och skaffa en token, konstruera en ny eller använd en befintlig HttpClient med DefaultRequestHeaders "Authorization" anges till Ägare "åtkomsttoken" och Ocp-Apim-Subscription-Key anges till prenumerationsnyckeln från Customer Insights - Data-miljö.

   Återställ rubriken Auktorisering när det är lämpligt. Till exempel när token löpt ut.

3. Skicka denna HttpClient i konstruktionen av CustomerInsights-klienten.

4. Ringa samtal med klienten till "tilläggsmetoderna", till exempel GetAllInstancesAsync. Om tillgång till underliggande Microsoft.Rest.HttpOperationResponse är att föredra, använd "http-meddelandemetoderna", till exempel GetAllInstancesWithHttpMessagesAsync.

5. Svaret kommer sannolikt att vara av typen object eftersom metoden kan returnera flera typer (till exempel IList<InstanceInfo> och ApiErrorResult). För att kontrollera returtypen använder du objekten i de svarstyper som anges på API-informationssidan för den åtgärden.

   Om mer information om begäran behövs använder du metoderna för http-meddelande för att komma åt råsvarsobjekt.

NodeJS-paket

Använd NodeJS-klientbiblioteken som är tillgängliga via NPM: https://www.npmjs.com/package/@microsoft/customerinsights

Python-paket

Använd Python-klientbiblioteken som är tillgängliga via PyPi: https://pypi.org/project/customerinsights/