# @fillout/api 中文文档

规范地址：https://npmcn.com/package/%40fillout/api/

版本：1\.5\.0
npm 元数据更新时间：2026-04-20T23:17:38.690Z
中文译文更新时间：2026-11-14T17:59:16.757Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40fillout/api
原文对照：https://npmcn.com/package/%40fillout/api/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：34.4 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2025-02-26T02:51:51.008Z
- 最新版本发布：2025-05-05T13:04:38.149Z
- 近 30 天下载量：14327（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 0 个）

## 中文简介

填充 API 客户端

## 安装

```sh
npm install @fillout/api
```

也可以使用：`pnpm add @fillout/api`、`yarn add @fillout/api`、`bun add @fillout/api`

## README

![Fillout logo](https://static.fillout.com/logos/fillout-icon.png)

# 填充 API 客户端

用于访问表格和提交文件的脚本 SDK 类型

  
  

## 连接到 API

```js
import { Fillout } from "@fillout/api"

const fillout = new Fillout(FILLOUT_API_KEY)
```

您可以为您的组织生成 API 密钥 [https://building.fillout.com/home/ settings/developer 互联网档案馆的存檔,存档日期2013-12-02](https://build.fillout.com/home/settings/developer)。它应该从 `sk_prod_`。 。 。 . 不要在代码中保存密钥 - 使用环境变量代替.

如果你在企业计划上, 并且有填充文件 主办在一个不同的区域, 你需要使用 `region` 选项,例如:

```js
const fillout = new Fillout(FILLOUT_API_KEY, { region: "eu" })
```

目前可用的值是 `us` (违约), `eu` 财务报告和审定财务报表 `ca`。检查开发者设置中的基础 URL.

## 从这些例子开始

以表格形式打印问题清单:

```js
const forms = await fillout.getForms()

const formName = "Fillout SDK"
const formId = forms.find((f) => f.name === formName)?.formId
if (!formId) throw new Error("Missing form")

const form = await fillout.getForm(formId)

console.log(`Questions available in ${formName}:

${form.questions.map((question) => `${question.name} (${question.type})`).join("\n")}`)
```

获取表格中最近提交的十份:

```js
const submissions = await fillout.getSubmissions("foAdHjd1Duus", {
  includePreview: true,
  limit: 10,
  sort: "desc",
})
```

## 文档

为了找出你能做的 看看我们 [API 文档](https://www.fillout.com/help/fillout-rest-api)。 。 。 . 此套件也有TypeScript和JSDoc的评论, 因此您应该在编辑器中获得一些有益的提示:

如果你想把填充器嵌入反射项目中 试试 [@ fillout/反应](https://npmjs.org/package/@fillout/react)来啊!

## 常见问题

### @fillout/api 是什么？

填充 API 客户端

### 如何安装 @fillout/api？

在项目目录运行 npm install @fillout/api，或使用 pnpm add / yarn add / bun add。

### @fillout/api 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @fillout/api 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @fillout/api 可以商用吗？

@fillout/api 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @fillout/api 的下载量有多少？

根据 npm 官方下载统计，@fillout/api 在 2026/10/15 – 2026/11/13 这 30 天内被下载 14,327 次，日均约 478 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @fillout/api 还在维护吗？

最新版本 1\.5\.0 发布于 2025/05/05（1\.5 年前）；至今共发布 9 个版本，其中过去 12 个月发布了 0 个；首次发布于 2025/02/26。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。