如何为 Azure 数字孪生配置 Postman

重要

Azure 数字孪生服务的新版本已发布。 鉴于新服务的扩展功能，本文档集中所述的原始 Azure 数字孪生服务 (已停用) 。

若要查看新服务的文档，请访问活动的 Azure 数字孪生文档。

本文介绍如何配置 Postman REST 客户端以与 Azure 数字孪生管理 API 进行交互并对其进行测试。 具体而言，本文介绍以下内容：

• 如何将 Azure Active Directory 应用程序配置为使用 OAuth 2.0 隐式授权流。
• 如何使用 Postman REST 客户端向管理 API 发出令牌承载 HTTP 请求。
• 如何使用 Postman 向管理 API 发出多部分 POST 请求。

Postman 摘要

通过 REST 客户端工具（如 Postman）开始使用 Azure 数字孪生，以准备本地测试环境。 Postman 客户端有助于快速创建复杂的 HTTP 请求。 前往 www.getpostman.com/apps 下载 Postman 客户端的桌面版本。

Postman 是一种 REST 测试工具，可将关键 HTTP 请求功能定位到有用的桌面和基于插件的 GUI 中。

通过 Postman 客户端，解决方案开发人员可以指定要调用和使用 TLS 的 HTTP 请求类型 (POST、 GET、 UPDATE、 PATCH 和 DELETE) 、API 终结点。 Postman 还支持添加 HTTP 请求标头、参数、表单数据和正文。

配置 Azure Active Directory 以使用 OAuth 2.0 隐式授权流

1. 按照 快速入门 中的步骤创建和配置 Azure Active Directory 应用程序。 或者，可以重复使用现有的应用注册。

   

2. 现在，将 重定向 URI 添加到 https://www.getpostman.com/oauth2/callback。

3. 选中 “隐式授予>访问令牌 ”复选框，允许使用 OAuth 2.0 隐式授权流。 选择“ 配置”，然后选择 “保存”。

4. 复制 Azure Active Directory 应用的 客户端 ID 。

获取 OAuth 2.0 令牌

在以下示例中，YOUR_MANAGEMENT_API_URL 代表数字孪生 API 的 URI：

https://YOUR_INSTANCE_NAME.YOUR_LOCATION.azuresmartspaces.net/management/api/v1.0

名称	替换为
YOUR_INSTANCE_NAME	Azure 数字孪生实例的名称
YOUR_LOCATION	托管实例的区域

设置并配置 Postman 以获取 Azure Active Directory 令牌。 之后，使用获取的令牌向 Azure 数字孪生发出经过身份验证的 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 应用注册的字母数字 租户 ID 。	microsoft

2. 前往 www.getpostman.com 下载应用。

3. 我们希望发出 GET 请求。 选择 “授权 ”选项卡，选择“OAuth 2.0”，然后选择“ 获取新访问令牌”。

   字段	Value
   授权类型	Implicit
   回调 URL	https://www.getpostman.com/oauth2/callback
   身份验证 URL	使用步骤 1 中的授权 URL
   客户端 ID	对从上一部分创建或重复使用的 Azure Active Directory 应用使用应用程序 ID
   作用域	留空
   状态	留空
   客户端身份验证	Send as Basic Auth header

4. 此时，客户端应如下所示：

   

5. 选择“请求令牌”。

6. 向下滚动并选择“使用令牌”。

发出多部分 POST 请求

完成上述步骤后，请将 Postman 配置为发出已经过身份验证的 HTTP 多部分 POST 请求：

1. 在“标头”选项卡下，添加具有值的 multipart/mixedHTTP 请求标头密钥内容类型。

   

2. 将非文本数据序列化为文件。 JSON 数据将另存为 JSON 文件。

3. 在 “正文 ”选项卡下，选择 form-data。

4. 通过分配 密钥 名称（选择） File添加每个文件。

5. 然后，通过“选择文件”按钮选择每个文件。

   

   注意

   • Postman 客户端不要求多部分区块有手动分配的 Content-Type 或 Content-Disposition。
   • 对于每个部分，不需要指定这些标头。
   • 必须为整个请求选择 multipart/mixed 其他适当的 内容类型 。

6. 最后，选择“ 发送 ”以提交多部分 HTTP POST 请求。 状态代码或200201指示成功请求。 相应的响应消息将显示在客户端接口中。

7. 通过调用 API 终结点验证 HTTP POST 请求数据：

   YOUR_MANAGEMENT_API_URL/spaces/blobs?includes=description
   

后续步骤

• 要了解有关数字孪生管理 API 以及如何使用它们的详细信息，请参阅如何使用 Azure 数字孪生管理 API。

• 使用多部分请求将 Blob 添加到 Azure 数字孪生的实体。

• 若要了解如何使用管理 API 进行身份验证，请阅读使用 API 进行身份验证。