开发前准备

使用 NodeJS SDK 调用服务端 API、处理事件和回调前，请确保你已创建了一个应用、安装 NodeJS 环境以及服务端 NodeJS SDK。

对于新手开发者，建议你直接上手体验开发自动回复机器人或开发卡片交互机器人教程，在教程示例代码中了解如何调用 API、处理事件和回调。

创建应用

在使用服务端 SDK 之前，你需要确保已在开发者后台创建了一个企业自建应用或商店应用。详情参考创建企业自建应用或创建商店应用。了解选择哪种应用，参考应用类型。

开放平台 NodeJS SDK 支持 Node 10.0.0 及以上，下载地址参见下载 Node.js。

你可以选择使用 npm 或 yarn 工具之一进行安装。

npm

npm install @larksuiteoapi/node-sdk

yarn

yarn add @larksuiteoapi/node-sdk

NodeJS SDK 提供了 ECMAScript、CommonJS 两种模块，同时支持原生 Javascript 和 Typescript 的使用。定义语句如下所示，NodeJS SDK 文档中所有的示例均使用的 Typescript。

Typescript

import * as lark from '@larksuiteoapi/node-sdk';

CommonJS

ECMAScript

import * as lark from '@larksuiteoapi/node-sdk';

调用服务端 API：介绍如何通过 SDK，自行构建 API Client、构造 API 请求、最终成功调用服务端 API。

处理事件：介绍如何通过 SDK 封装的长连接方式处理事件、如何自建 HTTP 服务器处理事件。

处理回调：介绍如何通过 SDK 封装的长连接方式处理回调、如何自建 HTTP 服务器处理回调。

场景示例：提供基于 SDK 实现的各类场景示例。