- 授权
- 用户取消授权
- 发起授权
- 获取 Access Token
- 获取用户信息
- 刷新 Access Token
- 接口索引 v2
- 新建文档 v2
- 查询文档 v2
- 重命名文档 v2
- 移动文档 v2
- 删除文档 v2
- 生成副本 v2
- 收藏文档 v2
- 置顶文档 v2
- 设置水印 v2
- 创建快捷方式 v2
- 恢复文档 v2
- 导入文档说明 v2
- 预导入文档 v2
- 上传文档至 COS v2
- 异步导入文档 v2
- 查询导入进度 v2
- 导出文档 v2
- 导出进度查询 v2
- 获取文档列表 v2
- 查询文件夹信息 v2
- 添加文件夹 v2
- 删除文件夹 v2
- 查询文件夹权限 v2
- 移动文件夹 v2
- 重命名文件夹 v2
- 查询用户访问权限 v2
- 转让文档所有权 v2
- 查看文档权限 v2
- 设置文档权限 v2
- 申请文档权限 v2
- 添加协作成员 v2
- 移除协作成员 v2
- 查询协作成员 v2
- 列表过滤 v2
- 关键字搜索 v2
- fileID 转换 v2
- 上传图片 v2
- 查询消息列表未读数量 v2
- 接口索引 v2
- Smartsheet 基本概念 v2
- 接口索引 v2
- 添加子表 v2
- 删除子表 v2
- 查询子表 v2
- 添加视图 v2
- 删除视图 v2
- 查询视图 v2
- 添加记录 v2
- 删除记录 v2
- 查询记录 v2
- 更新记录 v2
- 添加字段 v2
- 删除字段 v2
- 查询字段 v2
- 更新字段 v2
- 接口索引 v3
- 获取 Doc 文档内容 v3
- 更新 Doc 文档内容 v3
- 接口索引 v2
- 更新收集截止时间 v2
- 生成收集结果 v2
- 概况
- 简介
- 从小程序跳转
- 从经过微信认证的 App 跳转
- 从微信 H5 网页跳转
- 打开腾讯文档列表页
- 打开一篇文档或发布为网页的文档
- 打开模板商城、资料包领取等功能
- 导入文件到腾讯文档
- 跳转其他小程序
- 简介
- 通过小程序调用授权
- 通过 App 调用授权(微信小程序)
- 通过 App 调用授权(QQ 小程序)
- 授权后获取 Token
- 返回腾讯文档小程序
- 问题排查
- 常见错误码 v3
- 频率控制
- 请求头部 v2
- 常见错误码 v2
- folderID v2
- 文件信息 v2
- ID 介绍 v2
- 令牌长度
- ID 介绍 v2
- 文件元信息 v2
- folderID v2
- 文件类型 v2
- COS 文件信息 v2
- 列表类型和排序类型 v2
- 文件列表信息 v2
- 文件夹信息 v2
- 文件夹权限信息 v2
- 文档权限 policy v2
- 搜索文件类型 v2
- 搜索结果列表 v2
- 上传图片接口支持的图片类型 v2
- 查询子表 v2
- 添加子表 v2
- 删除多行(列) v2
- 清空区域内容 v2
- 更新区域内容 v2
- 批量插入图片 v2
- SheetProperties v2
- Smartsheet 基本概念 v2
- AddSheetRequest v2
- 参数列表 v2
- 参数列表 v2
- 参数列表 v2
- Document v3
- Request v3
- 文件来源 v2
授权
授权流程是第三方开发者经腾讯文档用户授权,获取用户自有资源访问令牌(Access Token)的过程。用户的资源包括用户的文档、 表格、智能表格、文件夹等。在web 应用中的交互流程如下:
在第三方小程序或App中,可通过跳转腾讯文档小程序(详见小程序),引导用户授权您的腾讯文档开放平台应用,发起授权流程,得到用于换取 access_token 的授权码,用于获取 Token 并调用腾讯文档开放平台 API。
1. 准备工作
登录腾讯文档开放合作平台 (opens new window),注册成为开发者。创建第三方应用且应用审核成功后,系统将自动分配 Client ID
和 Client Secret
。
Client ID: 第三方应用的唯一标识。在 OAuth2.0
授权和后续 OpenAPI
调用流程中需要作为请求参数。 Client Secret: Client ID
对应的密钥,在后台服务间接口调用时用来验证应用的合法性。
注意:Client Secret
用于验证开发者身份,需要对 Client Secret
进行妥善存储,不要随意泄漏。如发生泄露请及时登录开放平台修改。
2. 授权流程
腾讯文档采用 OAuth2.0
的授权码方式 (opens new window)来进行用户身份验证和获取用户授权。
授权过程分为 4
步:
1. 第三方应用构造并且发起授权请求。 详细内容见 发起授权接口。
2. 用户手动点击同意授权。
3. 带上 Authorization Code
重定向到第三方应用提供的回调地址。
4. 第三方应用后台服务使用 Authorization Code
换取 Access Token
和 Refresh Token
。 详细内容见获取 Token 接口。
参数 | 含义 | 有效时间 |
---|---|---|
Authorization Code | 授权码 | 有效时间为 5 分钟,且只能使用一次 |
Access Token | 用户的访问令牌 | 用户的访问令牌,发起所有 OpenAPI 请求都需要带上,用来认证用户身份和校验访问权限。Access Token 的有效期为 30 天,大小限制参考令牌长度 |
Refresh Token | 用户刷新令牌 | 用户刷新令牌,Access Token 过期后,可以用 Refresh Token 来更新 Access Token ,Refresh Token 的有效期为 1 年,大小限制参考令牌长度 |
注意:第 4 步中,必须在第三方应用的后台服务发起换取令牌的请求,谨防密钥泄漏。需要对用户的 Access Token
和 Refresh Token
进行妥善存储,不要随意泄漏。
3. 获取用户信息
拿到 Access Token
可以调用获取用户信息的接口来获取用户的 Open ID
、昵称、头像等基础信息。详细内容见获取用户信息接口。
Open ID
是用户的唯一标识,发起所有 Open API
请求都需要带上。
注意:Open ID
在个别情况下可能会变化,例如用户进行了帐号绑定或者解绑操作。
4. 调用 Open API
Open API
可以用来实现对用户的文档数据进行管理,和对文档内容进行读写。发起请求时,必须在 Request Header
中带上 Client ID
、Open ID
和 Access Token
三元组作为校验信息。
注意:为了安全考虑,所有访问腾讯文档 Open API
的请求需由后台服务发起。
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论