服务端 SDK 概述

飞书开放平台提供了一系列服务端的原子 API 来实现多元化的功能，但在实际编码过程中，需要考虑一些额外的工作，如访问凭证（access token）的获取与维护、数据加解密、请求验签等。此外，缺少函数调用的语义化描述、类型系统的支持，也会增加编码负担。

为解决以上问题，飞书开放平台提供了服务端 SDK，将所有冗长的逻辑内置处理，支持完备的类型系统，对外提供语义化的编程接口，以提高实际的编码体验。

SDK 提供的主要能力包括：

• SDK 支持 基于长连接的事件回调，详情见配置事件订阅方式、配置回调订阅方式。

• SDK 提供了 结构化的 API 请求入参。比如发消息 API，SDK 对各种类型的消息都提供了结构化封装。

  

• SDK 提供了 完整的应用访问凭证（tenant_access_token）生命周期管理能力，无需开发者自己获取并刷新应用身份的访问凭证。

  :::note SDK 仅支持托管应用身份的访问凭证（tenant_access_token），不支持托管用户身份的访问凭证（user_access_token），开发者需自行实现相关逻辑，参考 获取 user_access_token 、刷新 user_access_token 。 :::

• SDK 内 API 和事件上都添加了文字注释，以及跳转到使用 Demo 和官方文档的链接。

  

• SDK 提供了简洁易懂的帮助文档。参考 SDK 文档可帮助你了解如何安装 SDK、如何通过 SDK 调用服务端 API、处理订阅的事件及回调。

  • Java 开发指南
  • Python 开发指南
  • Go 开发指南
  • NodeJS 开发指南
  • SDK 常见问题

源码地址

你可以进入 GitHub 项目空间查看源码详情。在使用 SDK 的过程中，如果遇到问题，可以给我们提交 Issue。

GitHub 项目	Issues	场景示例	语言
oapi-sdk-go	Issues	oapi-sdk-go-demo	Golang >= 1.5
oapi-sdk-python	Issues	oapi-sdk-python-demo	Python >= 3.8
oapi-sdk-java	Issues	oapi-sdk-java-demo	Java >= 1.8
oapi-sdk-nodejs	Issues	-	NodeJS >= 10.0.0

SDK 问题交流群

Java SDK 交流群	Python SDK 交流群	Go SDK 交流群
单击此处或扫码加入 SDK 交流群。	单击此处或扫码加入 SDK 交流群。	单击此处或扫码加入 SDK 交流群。

NodeJS SDK 问题可直接提交Issues。

相关文档

• 服务端 API 列表
• 事件列表