接口联调流程
接口联调流程
购买腾讯会议企业版或者商业版后,腾讯会议将自动开通企业 API 接入能力和消息时间订阅能力,本文将为您介绍如何使用腾讯会议开发者工具进行接口联调,您可以通过以下步骤进行配置。
操作步骤如下:
- 登录 腾讯会议官网。
- 单击右上方【用户中心】进入个人中心页面。
- 单击左侧菜单栏【企业管理】>【高级】,在高级选项中创建密钥对 SecretID 和 SecretKey,同时获取鉴权时所需要的 APPID 和 SDKID。
步骤1:填写账号信息
账号信息的四个字段用来识别用户身份和鉴权,属于必填字段。
操作步骤如下:
- 进入腾讯会议 开发者联调工具。
- 使用 准备工作 获取的密钥等相关信息进行填写。
步骤2:填写请求信息
请求信息包含请求接口所需要的全部信息,主要包括接口 URI 、请求方式、接口请求参数、请求体与请求头,填写好请求接口的信息后即可请求 REST API 接口。
填写请求信息的操作步骤如下:
1. 选择测试接口
进入工具界面后,在”选择 API 接口“的下拉框中可以查看工具目前支持的 REST API 接口列表,在下拉框中选择需要联调的接口,API 接口的 URI 与请求方式将展示在左侧。
2. 填写请求参数
选定具体联调接口后,该接口相关的请求参数字段将展示在页面上,REST API 接口分为有请求参数的接口和无请求参数的接口。
<dx-tabs>
::: 有请求参数的接口
若联调的接口为有请求参数的接口,则请求参数将分为必填项和非必填项,其中必填项不可删除,非必填项可根据实际需要进行删除,如查询用户的会议列表接口。
:::
::: 无请求参数的接口
若联调的接口为无请求参数的接口,则页面不展示任何请求参数信息,如创建会议接口。
:::
</dx-tabs>
3. 填写请求体
当选定具体联调接口后,该接口请求体的描述信息将展示在页面上,REST API 接口分为有请求体的接口和无请求体的接口。
<dx-tabs>
::: 有请求体的接口
若联调的接口为有请求体的接口,则会将请求体信息以 JSON 字符串的格式显示在输入框中,如创建会议。其中请求体信息中的每个字段都有相应的描述,包括字段的数据类型以及是否必需(required),非必需字段则不包含 required 的描述信息。您可根据提示输入相应的字段信息来构建请求体,并根据实际需要进行删减,但务必确保 JSON 数据格式正确。
:::
::: 无请求体的接口
若联调的接口为无请求体的接口,则页面不展示任何请求体信息,如通过会议 ID 查询接口。
:::
</dx-tabs>
4. 填写请求头
当选定具体联调接口后,该接口请求头信息将展示在页面上,请求头字段分为必填字段和非必填字段,非必填字段可根据实际需要进行删除。请求头的字段涉及到调用 REST API 接口时的签名验证,所以务必确保正确填写请求头信息。
>!每次请求新的接口时,都需要重新生成 X-TC-Timestamp、X-TC-Nonce 与 X-TC-Signature 字段,否则将导致请求接口失败。
请求头字段说明
- X-TC-Key 字段为必填字段,当开发者输入账号信息后,账号信息中的 SecretID 字段的值将自动同步填充到该位置,无需再次填写。
- X-TC-Timestamp 字段为必填字段,单击【生成当前时间戳】,即可生成一个单位为秒的当前时间戳。
- X-TC-Nonce 字段为必填字段,单击【生成一个随机数】,即可生成一个随机整数。
- X-TC-Signature 字段为必填字段,单击【获取签名】可获取签名。
>!获取签名前,请先填写好账号信息、请求参数、请求体、X-TC-Timestamp 字段与 X-TC-Nonce 字段,否则生成的签名将无法通过调用 REST API 接口的签名验证过程。
- AppId 字段为可选字段,当开发者输入账号信息后,账号信息中的 APPID 的值将自动同步填充到该位置,无需再次填写。
下载 腾讯会议API 接口联调流程-腾讯会议.pdf
接口联调流程
接口联调流程
购买腾讯会议企业版或者商业版后,腾讯会议将自动开通企业 API 接入能力和消息时间订阅能力,本文将为您介绍如何使用腾讯会议开发者工具进行接口联调,您可以通过以下步骤进行配置。
准备工作
操作步骤如下:
登录 腾讯会议官网。
单击右上方【用户中心】进入个人中心页面。
单击左侧菜单栏【企业管理】>【高级】,在高级选项中创建密钥对 SecretID 和 SecretKey,同时获取鉴权时所需要的 APPID 和 SDKID。
步骤1:填写账号信息
账号信息的四个字段用来识别用户身份和鉴权,属于必填字段。
操作步骤如下:
进入腾讯会议 开发者联调工具。
使用 准备工作 获取的密钥等相关信息进行填写。
步骤2:填写请求信息
请求信息包含请求接口所需要的全部信息,主要包括接口 URI 、请求方式、接口请求参数、请求体与请求头,填写好请求接口的信息后即可请求 REST API 接口。
填写请求信息的操作步骤如下:
1. 选择测试接口
进入工具界面后,在”选择 API 接口“的下拉框中可以查看工具目前支持的 REST API 接口列表,在下拉框中选择需要联调的接口,API 接口的 URI 与请求方式将展示在左侧。
2. 填写请求参数
选定具体联调接口后,该接口相关的请求参数字段将展示在页面上,REST API 接口分为有请求参数的接口和无请求参数的接口。
<dx-tabs>
::: 有请求参数的接口
若联调的接口为有请求参数的接口,则请求参数将分为必填项和非必填项,其中必填项不可删除,非必填项可根据实际需要进行删除,如查询用户的会议列表接口。
:::
::: 无请求参数的接口
若联调的接口为无请求参数的接口,则页面不展示任何请求参数信息,如创建会议接口。
:::
</dx-tabs>
3. 填写请求体
当选定具体联调接口后,该接口请求体的描述信息将展示在页面上,REST API 接口分为有请求体的接口和无请求体的接口。
<dx-tabs>
::: 有请求体的接口
若联调的接口为有请求体的接口,则会将请求体信息以 JSON 字符串的格式显示在输入框中,如创建会议。其中请求体信息中的每个字段都有相应的描述,包括字段的数据类型以及是否必需(required),非必需字段则不包含 required 的描述信息。您可根据提示输入相应的字段信息来构建请求体,并根据实际需要进行删减,但务必确保 JSON 数据格式正确。
:::
::: 无请求体的接口
若联调的接口为无请求体的接口,则页面不展示任何请求体信息,如通过会议 ID 查询接口。
:::
</dx-tabs>
4. 填写请求头
当选定具体联调接口后,该接口请求头信息将展示在页面上,请求头字段分为必填字段和非必填字段,非必填字段可根据实际需要进行删除。请求头的字段涉及到调用 REST API 接口时的签名验证,所以务必确保正确填写请求头信息。
>!每次请求新的接口时,都需要重新生成 X-TC-Timestamp、X-TC-Nonce 与 X-TC-Signature 字段,否则将导致请求接口失败。
请求头字段说明
X-TC-Key 字段为必填字段,当开发者输入账号信息后,账号信息中的 SecretID 字段的值将自动同步填充到该位置,无需再次填写。
X-TC-Timestamp 字段为必填字段,单击【生成当前时间戳】,即可生成一个单位为秒的当前时间戳。
X-TC-Nonce 字段为必填字段,单击【生成一个随机数】,即可生成一个随机整数。
X-TC-Signature 字段为必填字段,单击【获取签名】可获取签名。
>!获取签名前,请先填写好账号信息、请求参数、请求体、X-TC-Timestamp 字段与 X-TC-Nonce 字段,否则生成的签名将无法通过调用 REST API 接口的签名验证过程。
AppId 字段为可选字段,当开发者输入账号信息后,账号信息中的 APPID 的值将自动同步填充到该位置,无需再次填写。
下载 腾讯会议API 接口联调流程-腾讯会议.pdf