跳到主要内容

通过 Apifox 调试 API

Apifox 是一体化的 API 协作平台，支持在线调试融云 server API。本指南将帮助您快速上手，通过简单的三步操作即可开始调试。

准备工作​

  • 从融云开发者控制台创建应用，并获取有效的 App-Key 和 App-Secret。
  • 通过网页浏览器访问 Apifox 官网，创建账号并登录。注：如果您使用 Safari 浏览器打开，请确保浏览器版本≥17，否则可能存在打不开的现象。

步骤 1：导入 API​

  1. 通过以下方式找到融云 API：

    在 API 参考文档页面中的请求方法部分，点击调试 API按钮，即可跳转到对应的接口页面。

    您也可以通过在 API 接口列表 跳转到接口页面。

  2. 将 API 导入到自己的项目。点击克隆项目按钮，将接口导入到自己的项目。

步骤 2：设置环境变量​

正确配置环境变量是成功调试的关键步骤。在您导入的接口项目中，按照以下步骤操作：

  1. 新建环境：右上角选择管理管理，在跳转的页面中点击新建环境。

  2. 设置前置 URL，填入https://数据中心域名。数据中心域名详见API 域名。

  3. 配置如下环境变量，将变量填写进本地值中：

    变量名填写值
    App-Key在融云控制台获取的 App Key。
    App-Secret在控制台获取 App Secret。

步骤 3: 调试接口​

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

  1. 在左侧菜单栏，通过IM 服务端>用户管理>POST 获取用户信息，找到"获取用户信息"接口。

  2. 配置请求参数

  • 在页面底部切换到「调试模式」
  • 在 Body 中设置参数：
JSON
{
  "userId": "user_001"
}
参数说明
  • userId：要查询的用户 ID，可以是您应用中任意有效的用户标识符
  • 支持批量查询，具体参数格式请参考接口文档

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

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

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

您还可以通过控制台查看如下调试信息：

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

最后于 更新