共用方式為

如何針對 Azure Digital Twins 設定 Postman

  • 發行項

重要

已發行新版本的 Azure Digital Twins 服務。 針對新服務的擴充功能，本檔集) 中所述的原始 Azure Digital Twins 服務 (已淘汰。

若要檢視新服務的檔，請流覽使用中的 Azure Digital Twins 檔。

本文說明如何設定 Postman REST 用戶端以進行互動，並測試 Azure Digital Twins 管理 API。 具體而言，其說明：

  • 如何設定 Azure Active Directory 應用程式以使用 OAuth 2.0 隱含授與流程。
  • 如何使用 Postman REST 用戶端，以向您的管理 API 提出權杖關聯的 HTTP 要求。
  • 如何使用 Postman，以向您的管理 API 提出多部分的 POST 要求。

Postman 摘要

使用 REST 用戶端工具 (例如 Postman \(英文\)) 來準備您的本機測試環境，藉以開始使用 Azure Digital Twins。 Postman 用戶端可協助快速建立複雜的 HTTP 要求。 前往 www.getpostman.com/apps 以下載 Postman 用戶端的桌面版本。

Postman \(英文\) 是一個 REST 測試工具，可將重要的 HTTP 要求功能定位為以外掛程式為基礎的實用桌面 GUI。

透過 Postman 用戶端，解決方案開發人員可以指定 HTTP 要求種類 (POST、 GET、 UPDATE、 PATCH和 DELETE) 、要呼叫的 API 端點，以及使用 TLS。 Postman 也支援新增 HTTP 要求標頭、參數、表單資料和內文。

設定 Azure Active Directory 以使用 OAuth 2.0 隱含授權流程

  1. 請遵循 快速入門 中的步驟來建立和設定 Azure Active Directory 應用程式。 或者，您可以重複使用現有的應用程式註冊。

    設定新的 Postman 重新導向 URI

  2. 現在，將 重新導向 URI 新增至 https://www.getpostman.com/oauth2/callback 。

  3. 選取 [隱含授> 與存取權杖] 核取方塊，以允許使用 OAuth 2.0 隱含授與流程。 選取 [ 設定]，然後選取 [ 儲存]。

  4. 複製 Azure Active Directory 應用程式的 用戶端識別碼 。

取得 OAuth 2.0 權杖

在以下範例中，YOUR_MANAGEMENT_API_URL 代表 Digital Twins API 的 URI：

https://YOUR_INSTANCE_NAME.YOUR_LOCATION.azuresmartspaces.net/management/api/v1.0
名稱 更換為
YOUR_INSTANCE_NAME Azure Digital Twins 執行個體的名稱
YOUR_LOCATION 裝載您執行個體的區域

設定 Postman 以取得 Azure Active Directory 權杖。 之後，使用取得的權杖來向 Azure Digital Twins 提出已驗證的 HTTP 要求：

  1. 確認您的授權 URL 正確無誤。 其應採用下列格式：

    https://login.microsoftonline.com/YOUR_AZURE_TENANT.onmicrosoft.com/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0
    名稱 更換為 範例
    YOUR_AZURE_TENANT 租使用者或組織的名稱。 使用人類易記的名稱，而不是 Azure Active Directory 應用程式註冊的英數位元 租使用者識別碼 。 microsoft

  2. 前往 www.getpostman.com 以下載應用程式。

  3. 我們想要提出 GET 要求。 選取 [ 授權] 索引標籤，選取 [OAuth 2.0]，然後選取 [ 取得新的存取權杖]。

    欄位 值
    授與類型 Implicit
    回呼 URL https://www.getpostman.com/oauth2/callback
    驗證 URL 使用步驟 1中的授權 URL
    用戶端識別碼 針對上一節所建立或重複使用的 Azure Active Directory 應用程式，使用 應用程式 識別碼
    範圍 保留空白
    省/市 保留空白
    用戶端驗證 Send as Basic Auth header

  4. 用戶端現在應該如下所示：

    Postman 用戶端權杖範例

  5. 選取 [要求權杖]。

  6. 向下捲動，然後選取 [使用權杖]。

提出多部分的 POST 要求

完成先前的步驟之後，設定 Postman 以提出已驗證的 HTTP 多部分 POST 要求：

  1. 在 [ 標頭] 索引 標籤下，新增 HTTP 要求標頭金鑰 Content-Type ，其值為 multipart/mixed 。

    指定內容類型 multipart/mixed

  2. 將非文字資料序列化到檔案。 JSON 資料會儲存為 JSON 檔案。

  3. 在 [ 本文] 索引標籤下，選取 form-data 。

  4. 藉由指派 金鑰 名稱來新增每個檔案，然後選取 File 。

  5. 接著，透過 [選擇檔案] 按鈕選取每個檔案。

    Postman 用戶端表單主體範例

    注意

    • Postman 用戶端不需要多部分區塊具有手動指派的 Content-type 或 Content-disposition。
    • 您不需要為每個部分指定這些標頭。
    • 您必須針對整個要求選取 multipart/mixed 或另一個適當的 內容類型 。

  6. 最後，選取 [傳送] 以提交多部分 HTTP POST 要求。 或 201 的狀態碼 200 表示成功的要求。 適當的回應訊息會出現在用戶端介面中。

  7. 呼叫 API 端點來驗證您的 HTTP POST 要求資料：

    YOUR_MANAGEMENT_API_URL/spaces/blobs?includes=description

後續步驟