在本文中我们为您介绍如何使用 Postman 调试服务端 API。
Postman 是一款 API 调测工具,可在让开发者在图形化界面中方便、直观地调试服务端 API。
为便于开发者调测 RoomKit 和教育云的服务端 API,我们提供了对应的Postman Collection,预先定义好了每个接口的请求参数,开发者导入后仅需修改参数取值即可调试。
已经下载并安装了 Postman。
已经下载并解压了 RoomKit 服务端 API 的 Collection。
已在 RoomKit 管理后台 创建项目,并获取初始化 RoomKit SDK 所必须的 SecretID、SecretSign、ProductID等信息。详见 开通 RoomKit 服务。
Postman 不同平台客户端的界面会略有差异,本文以 macOS 的 Postman 为例进行介绍。
本文提供的 Collection 仅供调测使用,并未包含 RoomKit 的所有服务端 API。
单击 "Import",将解压 collection 获取的两个文件一起导入。
将环境设置为 "roomkit"。
打开 “roomkit” 环境,将 前提条件 中获取的 ProductID、secret_id、secret_sign、secret_key 设置到对应环境变量的 “CURRENT VALUE” 中,然后保存。
在本章中,我们以 4 个接口为例介绍如何使用 Postman 调测服务端 API。
此 API 用于获取客户端登陆鉴权使用的 sdk_token。在调用此接口前,开发者需要先完成客户端的基础开发(详见 快速开始)并获取设备 ID。
将获取到的设备 ID 设置到环境变量 device_id
中。
在 Collections 中选择 “获取 SDK Token”,根据 API 文档 修改 Body 中参数的取值。双大括号包裹的参数值为环境变量,无需手动修改。
单击 “Send”,在下方查看响应内容。若响应消息的错误码不是 0,请根据响应消息中的错误描述修改请求再次发送。
为方便开发者调测,我们提供的 Collection 中使用前置脚本自动生成了 sign
参数的值,开发者若需要自行生成,可参考 API 文档。
此 API 用于获取服务端鉴权使用的 access_token,调用其他服务端接口时会需要携带 access_token 用于鉴权。
在 Collections 中选择 “获取服务器 AccessToken”。
单击 “Send”,在下方查看响应内容。若响应消息的错误码不是 0,请根据响应消息中的错误描述修改请求再次发送。
token
参数的值,开发者若需要自行生成,可参考 API 文档。access_token
会被自动保存到 Postman 的环境变量中,调用其他接口时无需再手动输入。但是开发者需要注意 access_token
的有效期,在 access_token
过期前重新调用该 API 刷新 access_token
。此 API 为教育云服务的 API,用于创建房间。若开发者的业务后台已具备房间管理能力,可以无需使用教育云服务的 API,直接使用自己的业务后台进行房间管理即可。
在 Collections 中选择 “创建房间”,根据 API 文档 修改 Body 中参数的取值。双大括号包裹的参数值为环境变量,无需手动修改。
单击 “Send”,在下方查看响应内容。若响应消息的错误码不是 0,请根据响应消息中的错误描述修改请求再次发送。
此 API 用于查询指定房间的在线人数。其中参数 room_id
可以是调用 "创建房间 API" 获取的 room_id
,也可以是开发者业务后台管理的房间 ID(但必须要有客户端加入过该房间)。
在 Collections 中选择 “房间当前在线人数”,根据 API 文档 修改 Body 中参数的取值。双大括号包裹的参数值为环境变量,无需手动修改。
单击 “Send”,在下方查看响应内容。若响应消息的错误码不是 0,请根据响应消息中的错误描述修改请求再次发送。
联系我们
文档反馈