2024年在线市场平台的11大最佳支付解决方案
如何获取飞书API开放平台访问token分步指南
在当今数字化办公时代,飞书作为一款高效协同办公平台,凭借其强大的功能和便捷的操作体验,赢得了众多企业和团队的青睐。为了更深入地集成飞书的功能,提升工作效率,开发者往往需要获取飞书API开放平台的访问Token。这一Token是接入飞书API并实现自动化办公的关键。
本文旨在详细指导你如何逐步获取飞书API开放平台的访问Token,确保你能够顺利接入并使用飞书提供的丰富API接口。通过本文,你将了解到从注册飞书开发者账号、创建应用,到最终获取访问Token的全过程。同时,我们还将简要介绍一些在使用过程中可能需要注意的事项,帮助你更高效、安全地利用飞书API进行办公协同。接下来,让我们开始这一分步指南的详细讲解。
1.登录注册飞书帐户
2.创建应用
创建应用。在开发者后台,根据实际需求,创建自建应用或者商店应用。
3.获取访问凭证
飞书开放平台设置了多种访问凭证(也称为 access_token
),不同的访问凭证代表了不同的资源访问权限。调用 API 时,必须在 HTTP Header 中携带访问凭证,以便获取权限范围内的资源信息。
获取自建应用的 tenant_access_token
- 登录开发者后台,选择指定的自建应用。
- 在 基础信息 > 凭证与基础信息 页面,获取应用凭证 App ID 和 App Secret。
- 调用自建应用获取 tenant_access_token 接口,通过应用凭证 App ID 和 App Secret 获取自建应用的
tenant_access_token
。
获取自建应用的 app_access_token
- 登录开发者后台,选择指定的自建应用。
- 在 基础信息 > 凭证与基础信息 页面,获取应用凭证 App ID 和 App Secret。
- 调用自建应用获取 app_access_token 接口,通过应用凭证 App ID 和 App Secret 获取自建应用的
app_access_token
。
获取商店应用的 app_access_token
- 获取 app_ticket。
- 为商店应用配置事件订阅请求地址。具体操作参见配置请求地址。完成配置后,飞书会每隔 1 小时向该地址自动推送最新的
app_ticket
,应用根据接收到的 app_ticket 事件来获取并保存app_ticket
,以便后续使用。 - (可选)调用重新获取 app_ticket 接口,触发飞书重新推送
app_ticket
。app_ticket
推送可能存在延迟,如果没有收到推送,可以使用该方式重新推送app_ticket
。
- 为商店应用配置事件订阅请求地址。具体操作参见配置请求地址。完成配置后,飞书会每隔 1 小时向该地址自动推送最新的
- 获取应用凭证 App ID 和 App Secret。
- 登录开发者后台,选择指定的自建应用。
- 在 基础信息 > 凭证与基础信息 页面,获取应用凭证 App ID 和 App Secret。
- 调用商店应用获取 app_access_token 接口,通过应用凭证 App ID 和 App Secret、以及 app_ticket 获取商店应用的
app_access_token
。
获取商店应用的 tenant_access_token
请先获取并保存商店应用的 app_access_token,再获取商店应用的 tenant_access_token。
- 获取 tenant_key。
tenant_key
为租户在飞书上的唯一标识,用来换取对应的tenant_access_token
,也可以用作租户在应用里面的唯一标识,可以通过如下方式获取:- 企业开通应用时,开放平台推送给应用的
tenant_key
数据,具体可参考首次启用应用。 - 用户登录到小程序、H5 应用或者浏览器应用时,在用户的身份信息中获取。
- 企业开通应用时,开放平台推送给应用的
- 调用商店应用获取 tenant_access_token 接口,通过
app_access_token
和tenant_key
获取商店应用的tenant_access_token
。
获取 user_access_token
本章节以应用的网页应用功能为例介绍如何获取 user_access_token。
获取 user_access_token 的方式同时适用于企业自建应用和商店应用。
- 登录开发者后台,选择指定应用。
- 在 开发配置 > 安全设置 页面,配置重定向 URL。你需要将实际发起 API 请求的服务端公网地址配置为应用的重定向 URL。重定向 URL 支持配置多个,只有在重定向 URL 列表中的 URL 在请求时才会通过开放平台的安全校验。
- 调用获取授权登录授权码接口,获取登录预授权码
code
。调用接口时需要使用应用凭证 App ID,你可以在应用详情页的 基础信息 > 凭证与基础信息 页面,获取应用凭证 App ID。 - 调用获取 user_access_token接口,获取
user_access_token
。同时可以获取到 Token 的有效期(expires_in 响应字段)。 - (可选)调用刷新 user_access_token接口,刷新
user_access_token
。user_access_token
的有效期为两小时左右,过期后,需要刷新后再使用。
4. 调用示例
向企业内员工发消息
你可以调用发送消息接口完成向企业内员工发消息的操作,从接口文档中可以确定,调用该接口前,需要获取 tenant_access_token
。
1.参考 获取访问凭证 获取 tenant_access_token
。获取凭证的请求示例如下,你需要将 app_id 和 app_secret 替换为实际值。
curl -X POST 'https://open.feishu.cn/open-apis/auth/v3/tenant_access_token/internal/'
-H 'Content-Type: application/json; charset=utf-8'
-d '{
"app_id": "<app_id>",
"app_secret": "<app_secret>"
}'
2.根据文档内的请求参数描述,调用发送消息接口。
方式一:在调试台发起 API 调用
方式二:本地发送 curl 请求该 API 需要使用 POST 方式发起。
示例如下,请将参数示例值替换为实际值。
curl -X POST 'https://open.feishu.cn/open-apis/im/v1/messages?receive_id_type=user_id'
-H 'Authorization:Bearer <tenant_access_token>'
-H 'content-type:application/json; charset=utf-8'
-d '{
"content": {
"text": "Hello World"
},
"msg_type": "text",
"receive_id": "<user_id>"
}'
- receive_id_type 作为查询参数。
- content 、msg_type 和 receive_id 作为请求的 Body 内容。
- 请求所需的
tenant_access_token
和 Content-Type 放在 Header 中。
5. 常见问题
问题1:如何找到飞书API
幂简集成是国内领先的API集成管理平台,专注于为开发者提供全面、高效、易用的API集成解决方案。幂简API平台可以通过以下两种方式找到所需API:通过关键词搜索API(例如,输入’飞书API‘这类品类词,更容易找到结果)、或者从API hub分类页进入寻找。
问题2:在“开发者助手”上提交问题,一般要填写哪些信息?
目前“开发者助手”上的工单主要分为两大类型:
(1)一类是OriginOS 开放能力、AI大模型、蓝河操作系统及其他开放内容的相关咨询,开发者需填写标题及详细描述,如有需要可上传图片等相关附件对问题进行更具体的描述。
(2)另一类是vivo系统上稳定性、多媒体等的技术问题反馈,开发者需填写标题、详细描述、机型、应用名这些必要信息及其他如系统版本等相关信息。另外,为了vivo工程师可以更快速、准确地对问题进行分析,请提供问题相关的日志。
问题3:如何提交问题相关的日志?
请按照以下步骤提交日志:
(1)打开电话,输入*##112##* , 根据实际问题选择具体的问题类型,一般情况下选择“通用”类型。
(2)复现问题
(3)打开电话,输入*##112##*,反馈,选择所有时间段日志上传。上传完后提供日志提取码给vivo。
问题4:什么情况下需要日志打印授权?
日志打印授权用于解决以下两种情况:
一是日志中部分敏感信息以星号(**)显示。–对应权限:日志脱敏
二是日志打印太频繁中间缺少部分日志。–对应权限:行数限制
对于开发flutter应用时出现无法调试的问题,可通过日志打印授权进行解决
问题5:飞书API 的替代品有哪些?
提供AI大模型服务商除飞书API,还有其他替代服务商也提供类似api服务,例如:
更多竞品可以在幂简API平台找到。
问题6:飞书API这个密钥还适用于哪些api?
获取登录用户信息、自建应用获取 tenant_access_token、自建应用获取 app_access_token
6. 总结
本文详细阐述了获取飞书API开放平台访问Token的全过程,为开发者提供了一个全面、实用的分步指南。从注册飞书开发者账号开始,通过完成应用创建和认证流程,到最终获取访问Token,每一步操作都进行了详尽的说明,旨在帮助开发者轻松完成Token的获取。虽然本文未直接提及,但获取Token后进行可用性测试的重要性不言而喻,这有助于确保开发者能够顺利地将飞书API集成到应用中,并提升应用的交互性和功能性。这一环节对于确保API的稳定性和准确性至关重要。本文为开发者提供了一个详尽而系统的指南,旨在帮助他们顺利获取飞书API开放平台的访问Token,并将其有效地集成到应用中,从而为企业和团队提供更加高效、便捷的协同办公体验。