# @commenda-integrations/rootfi-api 中文文档

规范地址：https://npmcn.com/package/%40commenda-integrations/rootfi-api/

版本：3\.2\.3
npm 元数据更新时间：2026-05-19T19:58:15.959Z
中文译文更新时间：2026-11-10T11:52:24.298Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1.5 MB，1486 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2026-05-19T19:58:15.335Z
- 最新版本发布：2026-05-19T19:58:15.767Z
- 近 30 天下载量：7839（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 1 个）

## 中文简介

赞扬一体化

## 安装

```sh
npm install @commenda-integrations/rootfi-api
```

也可以使用：`pnpm add @commenda-integrations/rootfi-api`、`yarn add @commenda-integrations/rootfi-api`、`bun add @commenda-integrations/rootfi-api`

## README

# RootFi 节点库

RootFi Node.js库提供从服务器侧JavaScript所写的应用程序中方便地访问RootFi API.

## 文档

见 [API 文件](https://docs.rootfi.dev/) 用于了解有关API的更多信息.

## 安装

```
npm install --save rootfi-api
# or
yarn add rootfi-api
```

## 证据

```typescript
import { RootFiClient } from "rootfi-api";

const rootfi = new RootFiClient({
    apiKey: "ROOTFI_API_KEY",
});
```

## 命名空间

RootFi SDK被组织成类别,每个类别都有自己的命名空间. 现有类别如下:

-   `core`: 用于管理公司的API并邀请链接
-   `accounting`: 管理发票、账单和其他会计数据的API
-   `ecommerce`:管理订单、产品和其他与电子商务有关的数据的API
-   `payments`: 用于管理支付和其他支付数据的API
-   `crm`:管理客户的API和其他客户关系管理相关数据

```typescript

const rootfi = new RootFiClient({
  apiKey: 'ROOTFI_API_KEY',
});

rootfi.accounting. // APIs specific to the Accounting Category

rootfi.payments. // APIs specific to the Payments Category
```

## 使用量

下面是您如何使用 RootFi Typescript SDK 的代码片段.

### 获取发票

```typescript
import { RootFiClient } from "rootfi-api";

const rootfi = new RootFiClient({ apiKey: "ROOTFI_API_KEY" });

invoices = await rootfi.accounting.invoices.list({ limit: 10, rootfiCompanyID: 234 });
```

### 获取命令

```typescript
import { RootFiClient } from "rootfi-api";

const rootfi = new RootFiClient({ apiKey: "ROOTFI_API_KEY" });

orders = await rootfi.ecommerce.orders.list({ limit: 10, rootfiCompanyID: 234 });
```

### 获取公司

```typescript
import { RootFiClient } from "rootfi-api";

const rootfi = new RootFiClient({ apiKey: "ROOTFI_API_KEY" });

const companies = await rootfi.core.companies.list({ limit: 10 });
```

### 粘贴数据

RootFi 遵循以光标为基础的 pagining 。 答复将包括: `next` 财务报告和审定财务报表 `prev` 属性。 要获得下一页, 您可以通过 `next` 转到该请求的光标属性。 类似地,要获得上页,您可以通过 `prev` 转到该请求的光标属性.

```typescript
import { RootFiClient } from "rootfi-api";

const rootfi = new RootFiClient({ apiKey: "ROOTFI_API_KEY" });

const orders = await rootfi.ecommerce.orders.list({
    limit: 10,
    rootfiCompanyID: 234,
    next: "eyJyb290ZmlfaWQiOjE4ODA2MDZ9",
});
```

### 创建账户

```typescript
import { RootFiClient } from "rootfi-api";

const rootfi = new RootFiClient({ apiKey: "ROOTFI_API_KEY" });

await rootfi.core.inviteLinks.create({
    company_name: "Test Company",
    integration_category: ["ACCOUNTING"],
});
```

### 获取和保存数据的样本代码

下面是一个样本代码,用于从RootFi API获取和保存数据到您的数据库. 您可以以此为起点来构建自己的数据同步进程.

```typescript
import { RootFiClient } from "rootfi-api";
const rootfi = new RootFiClient({ apiKey: "ROOTFI_API_KEY" });

async function fetchAllData() {
    let nextCursor = null;

    do {
        const response = await rootfi.accounting.invoices.list({ next: nextCursor, limit: 100 });
        const data = response.data;

        // Save data to your database

        nextCursor = response.next;
    } while (nextCursor);
}
```

## 常见问题

### @commenda-integrations/rootfi-api 是什么？

赞扬一体化

### 如何安装 @commenda-integrations/rootfi-api？

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

### @commenda-integrations/rootfi-api 支持 TypeScript 吗？

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

### @commenda-integrations/rootfi-api 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @commenda-integrations/rootfi-api 可以商用吗？

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

### @commenda-integrations/rootfi-api 的下载量有多少？

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

### @commenda-integrations/rootfi-api 还在维护吗？

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