API 在线调试器
1. 工具概览
API 在线调试器主要面向应用开发的前期准备环节,开发者通过调试器,无需编写代码,即可快速完成 WPS 365 服务端 OpenAPI 的调用。帮助开发者在实际开发前,充分了解接口的使用方式,提高应用开发效率。
2. 使用入口
请在登录后使用
3. 使用步骤
选择应用
所有 API 调试都需要以应用为基础,因此在调试前,需选择您想要调试的应用,当前仅支持“企业自建应用”。如尚无应用,请通过开发者后台创建应用。点此查看如何创建应用
选择环境
API 在线调试器为您了两套 WPS 365 环境数据可以调试
- 模拟环境:此时您调试的是模拟数据,非真实企业数据,调试过程比较简单,在应用开发前,推荐您使用模拟环境进行试用
- 生产环境:此时您调试的是生产数据,即您当前企业下真实的数据,接口调用后会对企业业务产生实际影响,如创建用户、发送消息等,调试过程也必须申请真实权限、授权 token,较为复杂,推荐在应用上线后,排障时使用
选择 API
通过左侧边栏的 API 列表,选择想要调试的 WPS 365 后,中间栏会显示该 API 需要的入参
填写调试信息
- 获取 token
可一键获取该接口需要的 token,可能为应用授权或用户授权,有些接口支持两种授权方式,您可通过下拉弹窗授权选择 模拟环境下,可以直接获取 token,无需真实的授权流程
- 申请权限 生产环境下,请确保当前应用具有想要调试的 API 权限,可在在线调试器页面申请,也可通过开发者后台申请,流程相同。点此查看详细的权限申请流程 模拟环境下,所有权限均默认开通,可直接调试
- 填写入参信息 分字段填下该接口需要的入参信息。如果对某个参数不了解,可以鼠标悬浮 ❔ 图标处,查看对参数的解释说明
发起调试
完成参数配置后,点击「运行调试」,即可在右侧边栏查看调试结果。