Postman 进行 OAuth 鉴权流程指引
简介
腾讯会议 Postman模板调试工具是为方便开发者进行腾讯会议 Rest API 接口联调而提供第三方开发调试工具。目前该工具支持 OAuth 鉴权与接口调试。下文将描述如何利用 Postman 工具调试 REST API。
操作步骤
步骤1:调试前准备
我们提供两种方式导入模板。
方式1:在线运行 Postman 模板库
通过这种方式,当模板更新后,您可以通过 Merge Changes 方式获取最新内容。
1. 单击以下按钮。
2. 单击 Fork Collection,登录账号或创建一个账号。
3. 再次单击 Fork collection,可以在 Collection 中看到导入进来的模板,切换环境为 oauth_environment 即导入完毕。
4. 您可以通过单击 Merge Changes 来获取最新内容。
方式2:将模板库文件导入 Postman 工具
在 Postman 中导入环境配置文件和接口模板,首先单击下面两个链接分别下载环境文件与接口集合文件到本地。
进入 Postman 并在 workspace 下单击 Import,导入两个文件。
如下图左侧 Tab 栏,Collection 中可以看到导入的新接口模板,里面接口包含 OAuth 鉴权环节接口和可供 OAuth 鉴权调试的会议 RestAPI ;Environment 中可以看到导入的环境,在这里可以配置环境参数,目前已提供一个测试应用用于调试,可以将其中内容替换为所测应用的信息。
环境参数中,将 sdk_id、secret、redirect_uri 替换为您测试应用的信息,您可以通过 腾讯会议 应用详情中查看。
步骤2:获取授权码
右上角切换环境为 oauth_environment,选择获取 auth_code,单击 send 发送请求。
复制这个链接到浏览器中打开,并且完成授权操作。
在浏览器 URL 处拿到 auth_code。
步骤3:获取 access_token
根据第二步中获取的 auth_code,调用此接口,替换 auth_code 内容。
获得 access_token、refresh_token 和 open_id。
步骤4:调用接口
准备 open_id 与 access_token,准备要测试的接口,以创建会议为例介绍调试过程:
1. 环境变量。
设置环境中的 OpenId 和 AccessToken 变量,替换为步骤2中获取到的自己刚才保存的值。
2. 编辑 Header。
根据 OAuth 鉴权 Header 要求,确认必填字段已填入。
3. 编辑 Params 和 Body,单击 send 发送请求。
4. 查看调试结果。
步骤5:刷新 access_token
由于 access_token 有效期为6小时,在过期之后需要通过 refresh_token 刷新 access_token 字段,用于继续正常调试接口。在 Body 中将 refresh_token 字段内容替换为请求 access_token 时获取到的 refresh_token 值。