RootFi 节点库

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

文档

见 API 文件 用于了解有关API的更多信息.

安装

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

证据

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和其他客户关系管理相关数据

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 的代码片段.

获取发票

import { RootFiClient } from "rootfi-api";

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

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

获取命令

import { RootFiClient } from "rootfi-api";

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

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

获取公司

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 转到该请求的光标属性.

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",
});

创建账户

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获取和保存数据到您的数据库. 您可以以此为起点来构建自己的数据同步进程.

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);
}