工具与资源
一、如何使用postman模板
为了降低集成门槛,方便开发者快速上手。特此提供可直接导入到Postman调试软件的环境用例(包含 collection用例集、已关联API测试专用云企业的环境environment),下载链接如下:
OpenApi(UC4X).postman_collection.json)
UC4X(866666企业级openapi).postman_environment.json)
UC4X(uc4xdemo系统级接口调用环境).postman_environment.json
使用方法:
-
下载Postman安装包,安装到PC电脑中,安装完成后打开软件。
-
下载Postman环境&用例。你可以看到3个文件,有一个collection.json结尾的和2个environment.json结尾的文件。
- 打开已安装好的Postman软件,点击左上角的Import或File--Import,分次导入步骤二获得的3个文件,导入后可看到以下界面。
- 展开OpenApi(UC4X),可看到测试的用例,environment分为企业级和系统级2个环境。标注为系统级接口使用系统级environment;其他使用企业级environment。首先发送身份验证token,鉴权通过后才可继续点击测试其他接口。鉴权通过的表现可参考下图所示。
- 其他接口测试可根据个人需求进行调用测试。
二、如何使用示例代码
若您具备Java开发经验,建议下载我们提供的Java示例代码UC_openapi-java-sdk-master.7z,利用test目录下的Demo.java进行接口调试。
使用方法:
- 结合具体的服务器部署情况,修改AccessKeyConfig中的鉴权秘钥accessKeyId和accessKeySecret,获取方法请参考API获取token鉴权介绍
注意:区分企业级和系统级接口,选择正确的秘钥, 无特殊情况,选择企业级秘钥即可,系统级接口应用场景较少 。
- 结合具体的服务器部署情况,修改DefaultServer中的服务器地址和端口,接口 仅支持通过https调用 。若有疑问可咨询亿联售前技术工程师。
- Demo中仅提供几个示例接口,其他接口测试可根据个人需求结合接口文档自行修改调试。
三、如何获得测试环境
为了帮助开发者测试,我们提供了公开的测试环境 uc4xdemo.yealinkops.com ,该环境支持创建多个企业。
1.你可以创建新的企业:
- 你可以咨询亿联售前技术工程师为你创建新的企业提供测试;
- 你也可以调用系统接口 添加企业 进行创建;
2.你可以创建新的用户账号:
- 你可以登录企业管理平台,在成员管理中创建测试账号;
注意:为保证其他开发者的使用正常,请不要删除其他测试账号
- 你也可以调用企业接口 添加用户进行创建。