Werken met Customer Insights - Gegevens-API's

Dynamics 365 Customer Insights - Data biedt API's voor het bouwen van uw eigen toepassingen op basis van uw gegevens in Customer Insights. Details van deze API's worden vermeld in de API-verwijzing. Ze bevatten aanvullende informatie over bewerkingen, parameters en antwoorden.

Aan de slag met het uitproberen van de API's

Een beheerder moet API-toegang tot uw gegevens inschakelen. Zodra toegang is ingeschakeld, kan elke gebruiker API gebruiken met de abonnementssleutel.

1. Meld u aan bij Customer Insights - Gegevens of meld u aan voor een proefversie van Customer Insights.

2. Ga naarInstellingenmachtigingen> en selecteer het tabblad API's.

3. Als API-toegang tot de omgeving niet is ingesteld, selecteert u Inschakelen.

   Als u de API's inschakelt, maakt u een primaire en secundaire abonnementssleutel voor uw omgeving die wordt gebruikt in de API-aanvragen. Als u de sleutels opnieuw wilt genereren, selecteert u de primaire of secundaire opnieuw genereren op het tabblad API's .

4. Selecteer Onze API's verkennen om de API's uit te proberen.

5. Zoek en selecteer een API-bewerking en selecteer Deze proberen.

   

6. Stel in het zijdeelvenster de waarde in het vervolgkeuzemenu Autorisatie in op impliciet. De Authorization header wordt toegevoegd met een Bearer-token. Uw abonnementssleutel wordt automatisch ingevuld.

7. Voeg eventueel alle benodigde queryparameters toe.

8. Schuif naar de onderkant van het zijvenster en selecteer Verzenden.

   Het HTTP-antwoord wordt onder aan het deelvenster weergegeven.

Een nieuwe app-registratie maken in Azure Portal

Maak een nieuwe app-registratie om de API's in een Azure-toepassing te gebruiken met gedelegeerde machtigingen.

1. Voltooi de sectie Aan de slag.

2. Meld u aan bij Azure Portal met het account dat toegang heeft tot de Customer Insights-gegevens.

3. Zoek en selecteer vervolgens App-registraties.

4. Selecteer Nieuwe registratie, geef een toepassingsnaam op en kies het accounttype.

   Voeg eventueel een omleidings-URL toe. http://localhost is voldoende voor het ontwikkelen van een toepassing op uw lokale computer.

5. Selecteer Registreren.

6. Ga in de nieuwe app-registratie naar API-machtigingen.

7. Selecteer Een machtiging toevoegen en selecteer Dynamics 365 AI for Customer Insights in het zijvenster.

8. Als machtigingstype selecteert u Gedelegeerde machtigingen en selecteert u vervolgens de machtiging user_impersonation .

9. Selecteer Machtigingen toevoegen.

10. Selecteer Beheerderstoestemming verlenen voor... om de app-registratie te voltooien.

11. Als u toegang wilt krijgen tot de API zonder dat een gebruiker zich aanmeldt, gaat u naar Machtigingen voor server-naar-servertoepassing instellen.

U kunt de toepassings-/client-id voor deze app-registratie gebruiken bij de Microsoft Authentication Library (MSAL) om een bearer-token te verkrijgen dat u met uw aanvraag naar de API wilt verzenden.

Zie Customer Insights-clientbibliotheken voor meer informatie over het gebruik van de API's in onze clientbibliotheken.

Machtigingen voor server-naar-servertoepassing instellen

Maak een app-registratie die geen gebruikersinteractie nodig heeft en kan worden uitgevoerd op een server.

1. Ga in uw app-registratie in Azure Portal naar API-machtigingen.

2. Selecteer Een machtiging toevoegen.

3. Selecteer de API's die mijn organisatie gebruikt en kies Dynamics 365 AI for Customer Insights in de lijst.

4. Voor machtigingstype selecteert u Toepassingsmachtigingen en selecteert u vervolgens de machtiging api.access .

5. Selecteer Machtigingen toevoegen.

6. Ga terug naar API-machtigingen voor uw app-registratie.

7. Selecteer Beheerderstoestemming verlenen voor... om de app-registratie te voltooien.

8. Voeg de naam van de app-registratie toe als gebruiker in Customer Insights - Data.

   1. Open Customer Insights - Gegevens, ga naarInstellingenmachtigingen> en selecteer Gebruikers toevoegen.

   2. Zoek de naam van uw app-registratie, selecteer deze in de zoekresultaten en selecteer Opslaan.

Voorbeeldvragen

Zie OData-queryvoorbeelden voor een korte lijst met OData-voorbeeldquery's om met de API's te werken.

Clientbibliotheken van Customer Insights

Ga aan de slag met de clientbibliotheken die beschikbaar zijn voor de Customer Insights - Data-API's. Alle broncode en voorbeeldtoepassingen van de bibliotheek vindt u in een GitHub-opslagplaats.

C# NuGet

Gebruik de C#-clientbibliotheken uit NuGet.org. Momenteel is het pakket gericht op de frameworks netstandard2.0 en netcoreapp2.0. Zie Microsoft.Dynamics.CustomerInsights.Api voor meer informatie over het NuGet-pakket.

De C#-clientbibliotheek toevoegen aan een C#-project

1. Open in Visual Studio NuGet Package Manager voor uw project.

2. Zoek naar Microsoft.Dynamics.CustomerInsights.Api.

3. Selecteer Installeren om het pakket toe te voegen aan het project.

   U kunt deze opdracht ook uitvoeren in de NuGet Package Manager-console: Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

De C#-clientbibliotheek gebruiken

1. Gebruik de Microsoft Authentication Library (MSAL) om een AccessToken gebruik te maken van uw bestaande Azure-app-registratie.

2. Nadat u een token hebt geverifieerd en verkregen, maakt u een nieuwe of gebruikt u een bestaande HttpClient met de DefaultRequestHeaders -autorisatie ingesteld op Bearer -toegangstoken en Ocp-Apim-Subscription-Key die is ingesteld op de abonnementssleutel vanuit uw Customer Insights - Data-omgeving.

   Stel de autorisatieheader zo nodig opnieuw in. Bijvoorbeeld wanneer het token is verlopen.

3. Geef dit HttpClient door aan de bouw van de CustomerInsights klant.

4. Maak bijvoorbeeld aanroepen met de client naar de 'extensiemethoden' GetAllInstancesAsync. Als toegang tot de onderliggende Microsoft.Rest.HttpOperationResponse gegevens de voorkeur heeft, gebruikt u bijvoorbeeld GetAllInstancesWithHttpMessagesAsyncde http-berichtmethoden.

5. Het antwoord is waarschijnlijk object type omdat de methode meerdere typen kan retourneren (bijvoorbeeld IList<InstanceInfo> en ApiErrorResult). Als u het retourtype wilt controleren, gebruikt u de objecten in de antwoordtypen die zijn opgegeven op de pagina API-details voor die bewerking.

   Als er meer informatie over de aanvraag nodig is, gebruikt u de http-berichtmethoden voor toegang tot het onbewerkte antwoordobject.

NodeJS-pakket

Gebruik de NodeJS-clientbibliotheken die beschikbaar zijn via NPM: https://www.npmjs.com/package/@microsoft/customerinsights

Python-pakket

Gebruik de Python-clientbibliotheken die beschikbaar zijn via PyPi: https://pypi.org/project/customerinsights/