飞书开发学习笔记(四)-飞书API的访问凭证获取

2023-11-06 13:44

本文主要是介绍飞书开发学习笔记(四)-飞书API的访问凭证获取,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

飞书开发学习笔记(四)-飞书API的访问凭证获取

一.了解飞书的访问凭证体系

飞书有一套完善的鉴权管理系统,在飞书API开发时,请求头中必须包含有相关的凭证信息。这个凭证信息是整个开发的安全所在,并且有对应的时效,所以了解飞书的这一套访问凭证体系是非常重要的。
获取访问凭证:获取访问凭证方法介绍
在这里插入图片描述
访问凭证分为三种:
tenant_access_token 租户授权凭证:应用代表租户(即企业或团队)执行对应操作,也就是说团队而非个人的场景。t-前缀。
user_access_token 用户授权凭证:代表用户执行的操作,比如云文档或日程。u-前缀。
app_access_token 应用授权凭证:应用使用自己的身份执行对应操作,不归属到具体的企业或用户。a-或t-前缀。

选择合适的访问凭证:
由于app_access_token的使用场景比较少,飞书开放平台正在逐步统一app_access_token和tenant_access_token两个凭证。

tenant_access_token
Tenant Access Token 代表使用应用的身份操作 OpenAPI,API 所能操作的数据资源范围受限于应用的身份所能操作的资源范围。

如果你的业务逻辑不需要操作用户的数据资源,仅需操作应用自己拥有的资源(比如在应用自己的文档目录空间下创建云文档),则推荐使用 Tenant Access Token,无需额外申请授权。

user_access_token
User Access Token 代表使用应用的使用者的身份操作 OpenAPI,API 所能操作的数据资源范围受限于用户的身份所能操作的资源范围。

如果你的业务逻辑需要操作用户的数据资源(例如需要在用户的文档目录空间下创建云文档),则推荐使用 User Access Token,无需额外申请授权。如果使用 Tenant Access Token,则需额外在资源层面为应用添加相应的授权。

以通讯录为例,如需使用 Tenant Access Token 调用通讯录,则需在开发者后台「权限管理」页面配置应用的通讯录权限范围;而使用 User Access Token 则无需单独配置通讯录权限范围,该范围遵循 User Access Token 所属的用户的通讯录权限范围。

二.获取相应的访问凭证

2.1凭证有效期

访问凭证存在有效期。
tenant_access_token和app_access_token的最大有效期是 2 小时。
user_access_token 的最大有效期是 6900 秒。
开发者需要在自己的服务端设置定时刷新凭证的业务逻辑,以防止过期。如在过期前 1.5 小时之内重新获取凭证,则会拿到与原值相同的值,但每次返回的剩余有效时间(expire)会发生变化,如下图所示。
在这里插入图片描述

2.2获取自建应用的 tenant_access_token

在 基础信息 > 凭证与基础信息 页面,获取应用凭证 App ID 和 App Secret。
这个在第一页是有说明的,用在API的headers里也能找到。
在这里插入图片描述
然后利用API获取 tenant_access_token
在这里插入图片描述
需要的参数: App ID 和 App Secret填入请求体,这两个参数是App创建完成之后固定不变的。

#API范例获取自建应用凭证tenant_access_tokenapp_id="cli_a3XXXXXX00e"
app_secret="kCp1XXXXXXXXXDu"
url = "https://open.feishu.cn/open-apis/auth/v3/tenant_access_token/internal"
payload = json.dumps({"app_id": app_id,"app_secret": app_secret
})headers = {'Content-Type': 'application/json'
}response = requests.request("POST", url, headers=headers, data=payload)
json_Data=json.loads(response.text)
# 打印返回体信息
print(json_Data)
tenant_access_token=json_Data['tenant_access_token']

这样,用这两个参数就获得了tenant_access_token
{‘code’: 0, ‘expire’: 3716, ‘msg’: ‘ok’, ‘tenant_access_token’: 't-xxxxxx}
返回体中有一个expire代表的是有效时间,3716代表还剩3716秒

说明: tenant_access_token 的最大有效期是 2 小时。如果在有效期小于 30 分钟的情况下,调用本接口,会返回一个新的 tenant_access_token,这会同时存在两个有效的 tenant_access_token。

2.3获取用户访问凭证 user_access_token

本章节以应用的网页应用功能为例介绍如何获取 user_access_token。如果你需要为应用的小程序能力获取user_access_token,则需要参考使用小程序提供的 code2session 接口。
获取 user_access_token 的方式同时适用于企业自建应用和商店应用。

登录开发者后台,选择指定应用。
在 开发配置 > 安全设置 页面,配置重定向 URL。
在这里插入图片描述
根据开发文档的介绍,需要应用中添加应用能力,比如小程序,网页或者移动应用登录等等,然后把
服务端URL进行重定向。这个过程比较复杂,就不进行展开了。
在这里插入图片描述
这里是网页应用免登以及二维码扫描登录的案例:
网页应用免登
https://open.feishu.cn/document/home/quickly-create-a-login-free-web-app/introduction
二维码扫描登录
https://open.feishu.cn/document/home/qr-code-scanning-login-for-web-app/introduction
在这里插入图片描述
飞书开放平台会校验应用发送过来的重定向 URL 的合法性,仅在重定向 URL 列表中的 URL 会通过校验。
在这里插入图片描述
这个API是https://open.feishu.cn/open-apis/authen/v1/access_token 方法为POST
需要的参数中 请求头的Authorization需要app_access_token
而请求体中的code需要 登录预授权码
都需要从其它方法中获得。
在这里插入图片描述

  1. 获取app_access_token
    在这里插入图片描述
    API https://open.feishu.cn/open-apis/auth/v3/app_access_token
    方法为POST
    在这里插入图片描述
    只有1个app_ticket需要获取,其它都是有的,以下为app_ticket的获取方法。

    根据以上说明,在配置请求地址以后,就可以通过接收消息获取最新的app_ticket,这样就得到了所有的参数可以执行app_access_token的查询和获得了。
  2. 获取登录预授权吗code
    获取登录预授权码
    在这里插入图片描述
    API格式,方法为GET
    在这里插入图片描述
    需要配置的参数如下:
    在这里插入图片描述
    redirect_uri:重定向URL地址,在应用的“安全设置”中设置
    app_id:应用id已经获得
    state:用来维护请求和回调状态的附加字符串, 在授权完成回调时会附加此参数,应用可以根据此字符串来判断上下文关系示例中为RANDOMSTATE
    根据以上,飞书API访问凭证获取就了解完成了,实际上还有很多具体内容需要掌握,以后再慢慢结合应用开发进行练习。

这篇关于飞书开发学习笔记(四)-飞书API的访问凭证获取的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/356981

相关文章

C++中RAII资源获取即初始化

《C++中RAII资源获取即初始化》RAII通过构造/析构自动管理资源生命周期,确保安全释放,本文就来介绍一下C++中的RAII技术及其应用,具有一定的参考价值,感兴趣的可以了解一下... 目录一、核心原理与机制二、标准库中的RAII实现三、自定义RAII类设计原则四、常见应用场景1. 内存管理2. 文件操

Python实例题之pygame开发打飞机游戏实例代码

《Python实例题之pygame开发打飞机游戏实例代码》对于python的学习者,能够写出一个飞机大战的程序代码,是不是感觉到非常的开心,:本文主要介绍Python实例题之pygame开发打飞机... 目录题目pygame-aircraft-game使用 Pygame 开发的打飞机游戏脚本代码解释初始化部

使用Python开发一个现代化屏幕取色器

《使用Python开发一个现代化屏幕取色器》在UI设计、网页开发等场景中,颜色拾取是高频需求,:本文主要介绍如何使用Python开发一个现代化屏幕取色器,有需要的小伙伴可以参考一下... 目录一、项目概述二、核心功能解析2.1 实时颜色追踪2.2 智能颜色显示三、效果展示四、实现步骤详解4.1 环境配置4.

SpringBoot服务获取Pod当前IP的两种方案

《SpringBoot服务获取Pod当前IP的两种方案》在Kubernetes集群中,SpringBoot服务获取Pod当前IP的方案主要有两种,通过环境变量注入或通过Java代码动态获取网络接口IP... 目录方案一:通过 Kubernetes Downward API 注入环境变量原理步骤方案二:通过

Go学习记录之runtime包深入解析

《Go学习记录之runtime包深入解析》Go语言runtime包管理运行时环境,涵盖goroutine调度、内存分配、垃圾回收、类型信息等核心功能,:本文主要介绍Go学习记录之runtime包的... 目录前言:一、runtime包内容学习1、作用:① Goroutine和并发控制:② 垃圾回收:③ 栈和

Python使用smtplib库开发一个邮件自动发送工具

《Python使用smtplib库开发一个邮件自动发送工具》在现代软件开发中,自动化邮件发送是一个非常实用的功能,无论是系统通知、营销邮件、还是日常工作报告,Python的smtplib库都能帮助我们... 目录代码实现与知识点解析1. 导入必要的库2. 配置邮件服务器参数3. 创建邮件发送类4. 实现邮件

使用Python实现获取屏幕像素颜色值

《使用Python实现获取屏幕像素颜色值》这篇文章主要为大家详细介绍了如何使用Python实现获取屏幕像素颜色值,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 一、一个小工具,按住F10键,颜色值会跟着显示。完整代码import tkinter as tkimport pyau

python获取cmd环境变量值的实现代码

《python获取cmd环境变量值的实现代码》:本文主要介绍在Python中获取命令行(cmd)环境变量的值,可以使用标准库中的os模块,需要的朋友可以参考下... 前言全局说明在执行py过程中,总要使用到系统环境变量一、说明1.1 环境:Windows 11 家庭版 24H2 26100.4061

如何搭建并配置HTTPD文件服务及访问权限控制

《如何搭建并配置HTTPD文件服务及访问权限控制》:本文主要介绍如何搭建并配置HTTPD文件服务及访问权限控制的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、安装HTTPD服务二、HTTPD服务目录结构三、配置修改四、服务启动五、基于用户访问权限控制六、

Android学习总结之Java和kotlin区别超详细分析

《Android学习总结之Java和kotlin区别超详细分析》Java和Kotlin都是用于Android开发的编程语言,它们各自具有独特的特点和优势,:本文主要介绍Android学习总结之Ja... 目录一、空安全机制真题 1:Kotlin 如何解决 Java 的 NullPointerExceptio