使用 Customer Insights - 資料 API

Dynamics 365 Customer Insights - Data 提供 API，可根據您在 Customer Insights 中的資料建置您自己的應用程式。 你可以在 API 參考中找到這些 API 的詳細資訊，其中包含操作、參數和回應的資訊。

備註

Customer Insights - 資料表也可以使用 Dataverse API 存取。 我們建議您使用 Dataverse API 來查詢 Customer Insights 資料，因為它們提供更廣泛的篩選、更高的輸送量和更低的延遲。 如需詳細資訊，請參閱適用於 Customer Insights 的 Dataverse API。

開始試用 API

管理員必須啟用對資料的 API 存取。 啟用存取權之後，任何使用者都可以將 API 與訂閱金鑰搭配使用。

  1. 登入 Customer Insights - 資料 或 註冊 Customer Insights 試用版。

  2. 移至 設定>許可權 並選取 API 索引標籤。

  3. 如果環境的 API 存取尚未設定，請選擇 啟用。

    啟用 API 時，你會為你的環境建立一個主要和第二個訂閱金鑰，並用於 API 請求。 要重新產生金鑰，請在 API 標籤中選擇 Regenerate main 或 Regenerate secondary 鍵。

  4. 選取 [探索我們的 API] 以試用 API。

  5. 搜尋並選取 API 作業，然後選取 [試用]。

    測試 API 的截圖。

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

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

  8. 捲動至側邊窗格底部，然後選取 [ 傳送]。

    HTTP 回應會顯示在窗格底部。

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

透過委派權限建立新的應用程式註冊，以便在 Azure 應用程式中使用 API。

  1. 完成 [開始使用] 區段。

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

  3. 搜尋並選取應用程式註冊。

  4. 選擇 新註冊，提供申請名稱，並選擇帳號類型。

    可選地，新增重新導向 URL。 http://localhost 足以在本機電腦上開發應用程式。

  5. 選取註冊。

  6. 在你的新應用程式註冊時，請前往 API 權限。

  7. 選取 新增權限 ，然後在側窗格中選取 Dynamics 365 AI for Customer Insights 。

  8. 針對 [許可類型]，選取 [ 委派的許可權 ]，然後選取 user_impersonation 許可權。

  9. 選取新增權限。

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

  11. 如要在使用者不登入的情況下存取 API，請移至 設定伺服器對伺服器應用程式權限。

您可以使用應用程式/用戶端識別碼來向 Microsoft 驗證程式庫 （MSAL） 註冊此應用程式，以取得持有人權杖，以隨您的要求傳送至 API。

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

設定伺服器對伺服器應用程式權限

建立一個不需要使用者互動、可以在伺服器上運行的應用程式註冊。

  1. 在 Azure 入口網站 中的應用程式註冊上，移至 [API 許可權]。

  2. 選取新增權限。

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

  4. 針對 [許可類型]，選取 [ 應用程式許可權 ]，然後選取 api.access 許可權。

  5. 選取新增權限。

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

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

  8. 將應用程式註冊名稱新增為 Customer Insights - 資料 中的使用者。

    1. 開啟 Customer Insights - 資料，移至 設定>權限， 然後選取 新增使用者。

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

範例查詢

如需使用 API 的 OData 範例查詢簡短清單，請參閱 OData 查詢範例。

Customer Insights 用戶端程式庫

開始使用 Customer Insights - 資料 API 可用的用戶端程式庫。 你可以在 GitHub 倉庫找到所有函式庫的原始碼和範例應用程式。

C# NuGet

使用 NuGet.org 中的 C# 用戶端程式庫。目前，該套件以 netstandard2.0 和 netcoreapp2.0 架構為目標。 欲了解更多 NuGet 套件的資訊，請參閱 Microsoft.Dynamics。CustomerInsights.Api。

將 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），透過現有的 Azure 應用程式註冊 來取得 AccessToken。

  2. 在你驗證並取得代幣後，再建立一個新的 HttpClient 代幣或使用現有的代幣。 將 DefaultRequestHeaders 的「授權」設為持有人的「存取權杖」，並將 Ocp-Apim-Subscription-Key 設為你 Customer Insights - 資料 環境中的訂閱金鑰。

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

  3. 將此 HttpClient 傳遞至 CustomerInsights 客戶端的構建中。

  4. 使用客戶端來呼叫「擴充方法」，例如 GetAllInstancesAsync。 如果你偏好存取底層Microsoft.Rest.HttpOperationResponse內容，可以使用「http 訊息方法」，例如。 GetAllInstancesWithHttpMessagesAsync

  5. 回應可能是 object 類型，因為方法可以傳回多個類型 （例如 和 IList<InstanceInfo>ApiErrorResult）。 若要檢查傳回類型，請使用該作業的 API 詳細資料頁面 上指定的回應類型中的物件。

    如果你需要更多關於請求的資訊，請使用 http 訊息方法 來存取原始回應物件。

Node.js 套件

請使用 NPM 提供的 Node.js 客戶端函式庫： https://www.npmjs.com/package/@microsoft/customerinsights

Python 套件

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

  • 上次更新時間：