通过 Postman 调试 API

Postman 是广受开发者欢迎的 API 调试工具，支持复杂的测试脚本和自动化功能。本指南将帮助您使用预配置的 Collection 和环境文件，快速调试融云平台聊天 API。

准备工作

• 安装 Postman（推荐版本 v10+）
• 从融云开发者控制台创建应用，并获取有效的 App-Key 和 App-Secret。
• 保存 Postman Collection 和环境配置文件，解压成下面两个配置文件：
  • 融云.postman_collection.json —— API 请求集合文件
  • 融云环境.postman_environment.json —— 环境配置文件

版本兼容性

建议使用 Postman v10 或更高版本，以确保所有功能正常工作。旧版本可能不支持某些脚本功能。

步骤 1： 导入 API

1. 打开 Postman。您也可以在 API 文档页面找到调试 API按钮，点击后选择 Postman。这将启动您的本地 Postman 应用，但您仍需要手动导入配置文件。

   

2. 点击左上角的 Import 按钮。

3. 选择导入您保存的 融云.postman_collection.json 文件。

4. 导入成功后，您将看到：

   • 左侧导航栏出现融云文件夹。

   • 展开后包含多个 API 分类（用户管理、群组管理、消息发送等）。

   • 每个分类下包含具体的 API 接口。

     

步骤 2：设置环境变量

1. 导入环境变量

   导入环境文件

   1. 打开 Postman 应用

   2. 左侧导航栏点击 Environments>Import。

      

   3. 选择导入您保存的融云环境.postman_environment.json 文件

   4. 确认导入后，左侧会出现融云环境

   手动创建环境

   您也可以手动创建环境：

   1. 点击 Environments > Create Environment。

      

   2. 设置环境名称为"融云"。

2. 激活环境。 点击右上角的环境选择器（默认为 No Environment），从下拉列表选择融云。

   

环境状态确认

激活成功后，右上角会显示「融云」字样，表示当前使用的环境。

3. 配置您的认证凭证。在左侧 Environments 中选择融云，在变量表格中设置下列信息：

变量名	填写值
App-Key	在融云控制台获取的 App Key。
App-Secret	在控制台获取 App Secret。
Host	https://数据中心域名，为您的应用对应的服务器地址。

信息

• Nonce、Timestamp、Signature 由系统自动生成，无需修改。
• 设置完成后按 Ctrl+S（Windows）或 ⌘+S（Mac）保存变更，否则将不会保存。

步骤 3： 发送请求

下文以"获取用户信息"为例，演示完整的调试流程：

1. 在左侧菜单栏，通过Collection>IM 服务端>用户管理>POST 获取用户信息，找到"获取用户信息"接口。
2. 配置如下参数：
   • 在 Params 标签页，可修改 URL 参数（如有需要）。
   • 在 Body 标签页，设置请求参数。

JSON

{
  "userId": "user_001"
}

3. 发送请求：点击 Send 按钮发送请求。Postman 内置了融云 API 的自动签名功能，每次请求会自动生成签名，并自动添加到请求头中。签名生成的逻辑，详见API 签名。

4. 成功请求后，您将看到类似以下响应：

• 响应状态。顶部状态栏显示 HTTP 状态码，200 OK 表示请求成功，4xx/5xx 表示请求失败。

• 响应体。返回的实际数据（JSON 格式）如下：

  JSON

  {
    "code": 0,
    "data": {
      "userId": "user_001",
      "nickname": "张三",
      "portraitUri": "https://example.com/avatar.jpg"
    }
  }

您还可以通过底部的 Console 查看如下调试信息：

• 原始签名字符串：用于验证签名算法
• 实际发送的 Header：确认请求头是否正确
• 请求耗时分析：性能调优参考