Arbeta med Customer Insights – Data-API:er

Dynamics 365 Customer Insights – Data tillhandahåller API:er för att skapa egna program baserat på dina data i Customer Insights. Du kan hitta detaljer om dessa API:er i API-referensen, som inkluderar information om operationer, parametrar och svar.

Kom igång med att testa API:erna

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

1. Logga in på Customer Insights – Data eller registrera dig för en utvärderingsversion av Customer Insights.

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

3. Om API-åtkomst till miljön inte är inställd, välj Aktivera.

   När du aktiverar API:erna skapar du en primär och sekundär prenumerationsnyckel för din miljö som du använder i API-förfrågningarna. För att återskapa nycklarna, välj Regenerate primary eller Regenerate 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 sidofönstret anger du värdet i listrutan Auktorisering till implicit. Sidhuvudet Authorization läggs till med en ägartoken. Din prenumerationsnyckel fylls automatiskt.

7. Du kan också lägga till alla nödvändiga frågeparametrar.

8. Rulla längst ned i sidofönstret och välj Skicka.

   HTTP-svaret visas längst ned i fönstret.

Skapa en ny appregistrering i Azure-portalen

Skapa en ny appregistrering för att använda API:erna i en Azure-applikation genom att använda 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 välj sedan Appregistreringar.

4. Välj Ny registrering, ange ett applikationsnamn och välj kontotyp.

   Du kan också lägga till en omdirigerings-URL. http://localhost är tillräckligt för att utveckla ett program på din lokala dator.

5. Välj Registrera.

6. Vid din nya appregistrering, gå 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. Som Behörighetstyp väljer du Delegerade behörigheter och väljer sedan behörigheten user_impersonation .

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

10. Välj Bevilja administratörsmedgivande för... för att slutföra appregistreringen.

11. Om du vill komma åt API:et utan att en användare loggar in går du till Ange programbehörigheter för server-till-server.

Du kan använda program-/klient-ID:t för den här appregistreringen med Microsofts autentiseringsbibliotek (MSAL) för att hämta en ägartoken som ska skickas 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 behörigheter för server-till-server-program

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

1. I din appregistrering i Azure-portalen går du till API-behörigheter.

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

3. Välj fliken API:er som min organisation använder och välj Dynamics 365 AI for Customer Insights i listan.

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

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

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

7. Välj Bevilja administratörsmedgivande för... för att slutföra appregistreringen.

8. Lägg till namnet på appregistreringen som 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 det i sökresultaten och välj Spara.

Exempelfrågor

En kort lista över OData-exempelfrågor som ska fungera med API:erna finns i OData-frågeexempel.

Customer Insights-klientbibliotek

Kom igång med de klientbibliotek som är tillgängliga för Customer Insights – Data-API:er. Du kan hitta all bibliotekets källkod och exempelapplikationer på ett GitHub-repo.

C# NuGet

Använd C#-klientbiblioteken från NuGet.org. För närvarande är paketet avsett för ramverken netstandard2.0 och netcoreapp2.0. För mer information om NuGet-paketet, se Microsoft.Dynamics. CustomerInsights.Api.

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

1. Öppna NuGet Správca balíkov för projektet i Visual Studio.

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

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

   Du kan också köra det här kommandot i NuGet Správca balíkov-konsolen: Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

Använda C#-klientbiblioteket

1. Använd Microsofts autentiseringsbibliotek (MSAL) för att få en AccessToken genom att använda din befintliga Azure-appregistrering.

2. Efter att du har autentiserat dig och skaffat en token, bygg en ny HttpClient eller använd en befintlig. Ange DefaultRequestHeaders "Authorization" till Bearer "access token" och ange Ocp-Apim-Subscription-Key till prenumerationsnyckeln från din Customer Insights – Data-miljö.

   Återställ Authorization-rubriken när det är lämpligt. Till exempel när tokenen går ut.

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

4. Ringa samtal med klienten till "tilläggsmetoderna", till exempel GetAllInstancesAsync. Om du föredrar åtkomst till den underliggande Microsoft.Rest.HttpOperationResponse, använd "http message methods", till exempel GetAllInstancesWithHttpMessagesAsync.

5. Svaret är sannolikt object typ eftersom metoden kan returnera flera typer (till exempel IList<InstanceInfo> och ApiErrorResult). Om du vill kontrollera returtypen använder du objekten i svarstyperna som anges på SIDAN API-information för den åtgärden.

   Om du behöver mer information om förfrågan, använd http-meddelandemetoderna för att komma åt råsvarsobjektet.

Node.js paket

Använd de Node.js klientbibliotek som finns 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/