填充 API 客户端

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

连接到 API

import { Fillout } from "@fillout/api"

const fillout = new Fillout(FILLOUT_API_KEY)

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

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

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

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

从这些例子开始

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

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")}`)

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

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

文档

为了找出你能做的 看看我们 API 文档。 。 。 . 此套件也有TypeScript和JSDoc的评论, 因此您应该在编辑器中获得一些有益的提示:

如果你想把填充器嵌入反射项目中 试试 @ fillout/反应来啊!