意見反映

搭配 Customer Insights API 處理

  • 文章

Dynamics 365 Customer Insights 提供 API，可根據 Customer Insights 中的資料建立您自己的應用程式。

重要

這些 API 詳細資料會列在 Customer Insights API 參考。 它們包含有關作業、參數和回應的其他資訊。

本文說明如何存取 Customer Insights API、建立 Azure 應用程式註冊，以及開始使用用戶端程式庫。

嘗試使用 Customer Insights API

  1. 登入 Customer Insights。 如果您尚未訂閱，請 註冊試用版的 Customer Insights。

  2. 若要在您的 Customer Insights 環境中啟用 API，請移至 系統管理員 > 安全性。 您必須具備系統管理員權限才能執行此動作。

  3. 前往 API 索引標籤，然後選取 啟用 按鈕。

    啟用 API 會為您的執行個體建立 API 要求使用的主要和次要訂閱金鑰。 您可以在 系統管理員 > 安全性 > API 中，選取 重新產生主要 或 重新產生次要，以重新產生金鑰。

  1. 選取 探索我們的 API試用 API。

  2. 選擇 API 作業並選取 嘗試。

  3. 在側邊窗格中，將 授權 下拉式功能表中的值設為 隱含。 Authorization 標頭會以持有人權杖的方式新增。 將會自動填入您的訂閱金鑰。

  4. 或者新增所有必要的查詢參數。

  5. 滾動到側窗格底端後選取 傳送。

HTTP 回應將很快在下方出現。

在 Azure 入口網站建立新的應用程式註冊

這些步驟可協助您使用委派權限在 Azure 應用程式中開始使用 Customer Insights API。 請務必先完成開始使用工作階段。

  1. 使用可存取 Customer Insights 資料的帳戶登入 Azure 入口網站。

  2. 選取左邊的 應用程式註冊。

  3. 選取 新增註冊 提供應用程式名稱並選擇帳戶類型。

    或者新增重新導向 URL。 http://localhost 可足以用來開發本機電腦上的應用程式。

  4. 在您的新應用程式註冊上前往 API 權限。

  5. 選取 新增權限，並選取側邊窗格中的 Dynamics 365 AI for Customer Insights。

  6. 在 權限類型 中，選取 委派權限，然後選取 user_impersonation 權限。

  7. 選取 新增權限。 如果您需要在無使用者登入時存取 API，請查看 伺服器對伺服器應用程式權限 區。

  8. 選取 授與系統管理員同意... 完成應用程式註冊。

您可以使用此應用程式註冊的應用程式/用戶端 ID 註冊 Microsoft 驗證程式庫（MSAL）取得持有人權杖，將您的要求傳送給 API。

如需 MSAL 詳細資訊，請見 Microsoft 驗證程式庫（MSAL）總覽。

如需有關 Azure 中的應用程式註冊的詳細資訊，請參閱註冊應用程式。

如需在用戶端程式庫中使用 API 的更多資訊，請參閱Customer Insights 用戶端程式庫。

伺服器到伺服器應用程式權限

應用程式註冊區 概述如何註冊要求使用者登入驗證的應用程式。 瞭解如何建立不需要使用者互動且可在伺服器上執行的應用程式註冊。

  1. 在 Azure 入口網站中您的應用程式註冊上，前往 API 權限。

  2. 選取 新增權限。

  3. 選取 我的組織使用的 API 索引標籤，然後從清單中選擇 Dynamics 365 AI for Customer Insights。

  4. 在 權限類型 中，選取 應用程式權限，然後選取 CustomerInsights.Api.All 權限。

  5. 選取 新增權限。

  6. 返回 API 權限 進行應用程式註冊。

  7. 選取 授與系統管理員同意... 完成應用程式註冊。

  1. 若要總結，我們必須將應用程式註冊名稱新增為 Customer Insights 使用者。

    開啟 Customer Insights，移至 系統管理員 > 安全性，然後選取 新增使用者。

  2. 搜尋您的應用程式註冊名稱，從搜尋結果選取它，然後選取 儲存。

範例查詢

我們已彙整了使用 API 的 OData 範例查詢的簡短清單：OData 查詢範例。

Customer Insights 用戶端程式庫

本節幫助您開始使用可用於 Customer Insights API 的用戶端程式庫。 您可以在 Customer Insights GitHub 頁面上找到所有的程式庫來原始程式碼和範例應用程式。

C# NuGet

瞭解如何開始從 NuGet.org 使用 C# 用戶端程式庫。如需更多有關 NuGet 套裝軟體的詳細資訊，請見 Microsoft.Dynamics.CustomerInsights.Api。 目前此套裝軟體鎖定 netstandard 2.0 和 netcoreapp 2.0 框架為目標。

將 C# 用戶端程式庫新增到 C# 專案

  1. 在 Visual Studio 中打開您的專案的 NuGet 套裝程式管理員。

  2. 搜尋 Microsoft.Dynamics.CustomerInsights.Api。

  3. 選取 安裝，以便將套裝程式新增到專案。

    或者在 NuGet 套裝程式管理員主控台 中執行此命令：Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

使用 C# 用戶端程式庫

  1. 使用 Microsoft 驗證程式庫 (MSAL) 取得 AccessToken 使用現有的 Azure 應用程式註冊。

  2. 當您成功驗證並獲取權杖之後，請建立新的或使用現有的 HttpClient，在其中設定 DefaultRequestHeaders "Authorization" 為 Bearer "access token" 以及設定 Ocp-Apim-Subscription-Key 為 Customer Insights 環境中您的 訂閱金鑰。

    請適時重設 授權 標頭。 例如當權杖到期時。

  3. 將此 HttpClient 傳遞到 CustomerInsights 用戶端的建構過程。

  1. 讓用戶端與「擴充方法」呼叫—例如，GetAllInstancesAsync。 如果偏好存取基礎 Microsoft.Rest.HttpOperationResponse，請使用「HTTP 訊息方法」—例如 GetAllInstancesWithHttpMessagesAsync。

  2. 回應類型將很有可能是 object，因為方法會傳回多種類型 (例如，IList<InstanceInfo> 和 ApiErrorResult)。 若要檢查回傳類型，請使用該作業的 API 詳細資料頁面 上指定回應類型中的物件。

    如果需要更多要求資訊，請使用 HTTP 訊息方法 存取原始回應物件。

NodeJS 套件

可透過 NPM 使用 NodeJS 用戶端程式庫：https://www.npmjs.com/package/@microsoft/customerinsights

Python 套件

可透過 PyPi 使用 Python 用戶端程式庫：https://pypi.org/project/customerinsights/

備註

是否能請您告知您偏好的慣用文件語言？ 請填寫問卷。 (請注意，本問卷為英文版)

完成問卷大約需要七分鐘。 本問卷將不會收集個人資料 (隱私權聲明)。