飞书开发学习笔记(一)-应用创建和测试

飞书开发学习笔记(一)-应用创建和测试

一.前言

现在大企业用的办公IM软件中,飞书是口碑最好的,不得不说,字节在开发产品方面,确实有自己独到的竞争力,比如说抖音、头条、飞书。在办公会议和云文档的体验上,其它的办公IM软件可以说完全不是对手。为了在办公中能够高效率的完成一些数据的收集并创建文书文档,学习一下飞书的开发是很有意义的。基于此,我想从飞书的开发文档开始,学习一些飞书的二次开发方案,并记录为学习笔记。

二.开发文档

飞书的开发文档地址为: https://open.feishu.cn/document/home/index
根据应用的能力形态,飞书应用主要可分为 机器人、网页、小程序、小组件四类。
不过如果简单的二次开发,飞书提供了强大的API文档和工具台。也就是说,利用python或者C#,只要进行简单的API调用,就能完成飞书的开发,对于云文档的操作就可以完成了。
那么,首先利用飞书API工具台和API函数,进行简单开发,就是比较适合的入门学习。

2.1 飞书开放平台

飞书开放平台:https://open.feishu.cn/app?lang=zh-CN
打开之后,进入开放平台页面。
开发工具之前,需要先自建一个应用,这个目的只是建立一个应用入口,作为应用的入口和凭证。
建立之后,就能够出现开发的工具台和教程。
飞书开发学习笔记(一)-应用创建和测试_第1张图片
在设计应用中,首先是介绍文档。
开放能力介绍: https://open.feishu.cn/document/client-docs/intro
飞书的框架中,开放平台的所有能力,不论是小程序/H5/机器人,还是开发API接口,都能通过飞书提供的API进行开发。
飞书开发学习笔记(一)-应用创建和测试_第2张图片
优秀开发案例: 地址
这里有一些比较好的开发案例,其中有一个:利用服务器端OpenAPI实现文档自动导出就挺好的,多逛一逛,看一看能够学习到不少开发的思路和点子。

2.2 搭建应用

点击 创建企业自建应用
飞书开发学习笔记(一)-应用创建和测试_第3张图片

创建完成后,可先不添加应用能力,比如“小程序/组件/机器人"。

在这里插入图片描述

由于正式的应用需要发布后,向企业申请权限,调试比较麻烦,所以这里先创建一个测试版本。
利用测试企业和人员来测试API的情况,是比较方便的。

飞书开发学习笔记(一)-应用创建和测试_第4张图片
切换到测试应用后,可以申请API操作相关应用权限。
在这里插入图片描述

在测试应用中,默认自己就是管理员身份,因此申请权限时是申请就开通。
飞书开发学习笔记(一)-应用创建和测试_第5张图片

2.3 飞书API

飞书开发学习笔记(一)-应用创建和测试_第6张图片

测试应用和权限开通后,就可以看到这样一个API调试台,左侧有应用的鉴权凭证,
左下方有全部的API列表,右侧则是API调试的请求头和请求体,按照要求填写后请求参数后,就可以点击
开始调试 进行API调试了。
飞书开发学习笔记(一)-应用创建和测试_第7张图片
飞书开放平台提供的 API 遵循 RESTful 风格,请求 URL 的格式为:
在这里插入图片描述
调用服务端 API 的流程如下图所示。

在这里插入图片描述

创建应用。在开发者后台,根据实际需求,创建自建应用或者商店应用。
仅拥有 ISV 资质的用户可以创建商店应用。有关 ISV 的详细介绍,请参考如何入驻飞书开放平台。
获取访问凭证。飞书开放平台设置了多种访问凭证(也称为 access_token),不同的访问凭证代表了不同的资源访问权限。调用 API 时,需要在 HTTP Header 中携带访问凭证,以便获取权限范围内的资源信息。

申请 API 权限。如果要调用 API,需要先获取接口调用权限;如果涉及到访问敏感字段,还需获取访问敏感字段的权限。

(可选)配置应用数据权限。当应用申请了部分 API 的权限(例如,通讯录、飞书人事企业版)后,还需要配置相应的数据权限并提交审核。待审核通过后权限生效,才可以成功调用 API 获取数据,否则调用 API 时会返回权限错误。

(可选)设置 IP 白名单。为了提升应用的安全性,可以为应用设置 IP 白名单。仅当源 IP 在白名单内时,飞书开放平台才会响应,否则请求将被拒绝。

调用 API。完成上述步骤后,便可以调用 API 了。你可以参考 API 文档,了解 API 的具体功能。

三.测试应用

3.1 鉴权

刷新口令token后,在API的自建应用获取中,将API的请求体中的app_id和app_secret复制下来,开发中需要使用。
飞书开发学习笔记(一)-应用创建和测试_第8张图片

3.2 测试API

以 自建应用获取 tenant_access_token 这个API为例,测试工作台中需要填写的参数分别为请求头和请求体。
飞书开发学习笔记(一)-应用创建和测试_第9张图片
测试工作台中,请求头和请求体已经自动填好了,点击 开始调试 就可以看到响应的结果。
飞书开发学习笔记(一)-应用创建和测试_第10张图片
返回的状态码为 200 显示测试API成功。
返回的数据是一个json字符串,返回了code,expire,msg和tenant_access_token四个结果,而第四个就是口令。
至此,初步的应用创建和测试已经成功,利用API查询到了tenant_access_token的结果。

你可能感兴趣的:(飞书开发学习笔记,JSON,飞书,学习,笔记)