# @formbricks/api 中文文档

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

版本：3\.0\.0
npm 元数据更新时间：2024-12-19T08:48:24.326Z
中文译文更新时间：2026-11-15T08:34:31.258Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：59.9 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2023-06-28T11:13:59.783Z
- 最新版本发布：2024-12-19T08:48:24.149Z
- 近 30 天下载量：30491（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 0 个）

## 中文简介

Formbricks-api是 Formbricks 客户端 API 的 Api 包装器

## 安装

```sh
npm install @formbricks/api
```

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

## README

# @ formbricks/ api - 用于 Formbricks 的 API 包装器

这是Formbricks的官方API包装. 它用于与Formbricks API交互. 要知道更多关于Formbricks,访问 [Formbricks.com (英语)](https://formbricks.com/)。 。 。 .

直接的API文档可见于我们的官方文件 [这里](https://formbricks.com/docs/api/client/overview)。要与Formbricks API互动,您需要环境标识。 你可以从Formbricks的仪表板上得到 [app.formbricks.com (中文(简体) )](https://app.formbricks.com/)。 。 。 .

## 安装

```bash
npm install @formbricks/api
```

## 使用量

### 输入

```ts
import { FormbricksAPI } from "@formbricks/api";

const api = new FormbricksAPI({
  apiHost: `https://app.formbricks.com`, // If you have self-hosted Formbricks, change this to your self hosted instance's URL
  environmentId: "<environment-id>", // Replace this with your Formbricks environment ID
});
```

API 客户端现在准备在您的整个项目中使用 。 它可用于与以下模型的相互作用:

### 显示

-   创建显示
    
    ```ts
    await api.client.display.create({
      surveyId: "<your-survey-id>", // required
      userId: "<your-user-id>", // optional
      responseId: "<your-response-id>", // optional
    });
    ```
    

### 回应

-   创建响应
    
    ```ts
    await api.client.response.create({
      surveyId: "<your-survey-id>", // required
      finished: boolean, // required
      data: {
        questionId: "<answer-to-this-question-in-string>",
        anotherQuestionId: 123, // answer to this question in number
        yetAnotherQuestionId: ["option1", "option2"], // answer to this question in array,
      }, // required
    
      userId: "<your-user-id>", // optional
      singleUseId: "<your-single-use-id>", // optional
      ttc: {
        questionId: 123, // optional
      }, // optional
      meta: {
        source: "<your-source>", // optional
        url: "<your-url>", // optional
        userAgent: {
          browser: "<your-browser>", // optional
          device: "<your-device>", // optional
          os: "<your-os>", // optional
        },
        country: "<your-country>", // optional
      }, // optional
    });
    ```
    
-   更新答复
    
    ```ts
    await api.client.response.update({
      responseId: "<your-response-id>", // required
      finished: boolean, // required
      data: {
        questionId: "<answer-to-this-question-in-string>",
        anotherQuestionId: 123, // answer to this question in number
        yetAnotherQuestionId: ["option1", "option2"], // answer to this question in array,
      }, // required
      ttc: {
        questionId: 123, // optional
      }, // optional
    });
    ```
    

### 联系人属性

-   更新联系人属性
    
    ```ts
    await api.client.attribute.update({
      userId: "<your-user-id>", // required
      attributes: {
        plan: "Pro",
      }, // required
    });
    ```
    

### 存储

-   上传文件
    
    ```ts
    await api.client.storage.uploadFile(
      file: File, // required (of interface File of the browser's File API)
      {
        allowedFileTypes: ["file-type-allowed", "for-example", "image/jpeg"], // optional
        surveyId: "<your-survey-id>", // optional
    
      } // optional
    );
    ```
    

如果你有任何问题或需要帮助, 请随意联系我们 [Github 讨论](https://github.com/formbricks/formbricks/discussions)

## 常见问题

### @formbricks/api 是什么？

Formbricks-api是 Formbricks 客户端 API 的 Api 包装器

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

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

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

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

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

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

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

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

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

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

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

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