# @firmenakte/api-client 中文文档

规范地址：https://npmcn.com/package/%40firmenakte/api-client/

版本：2\.34\.0
npm 元数据更新时间：2026-11-14T01:39:42.186Z
中文译文更新时间：2026-11-14T20:08:16.579Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40firmenakte/api-client
原文对照：https://npmcn.com/package/%40firmenakte/api-client/?lang=original
项目主页：https://docs.firmenakte.at/

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

- 包体积（解压后）：1.8 MB，65 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-03-05T11:57:38.734Z
- 最新版本发布：2026-11-14T01:39:42.032Z
- 近 30 天下载量：2380（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：29（近 12 个月 29 个）

## 中文简介

Firmenakte API 的脚本/ JavaScript 客户端

## 安装

```sh
npm install @firmenakte/api-client
```

也可以使用：`pnpm add @firmenakte/api-client`、`yarn add @firmenakte/api-client`、`bun add @firmenakte/api-client`

## README

# @ wardenakte/ api- 客户端

类型脚本/ Java脚本客户端 [法尔梅纳克特](https://docs.firmenakte.at/) API (英语).

## 安装

```bash
npm install @firmenakte/api-client
```

或带pnm:

```bash
pnpm add @firmenakte/api-client
```

## 快开始

```ts
import { createApiClient } from "@firmenakte/api-client";

const api = createApiClient({
  apiKey: "your-api-key",
  baseUrl: "https://api.firmenakte.at", // optional, defaults to production
  timeoutMs: 10_000, // optional, defaults to 10 seconds
});

// Use the API, e.g. list businesses
const { data } = await api.v1BusinessesList();
```

每一个请求都单独开始超时,并覆盖阅读其响应体. 通过一个 `AbortSignal` 当呼叫者需要提前取消时, 在结束点的请求参数中:

```ts
const controller = new AbortController();
const request = api.v1BusinessesList(undefined, { signal: controller.signal });
controller.abort();
await request;
```

## 页:1

V2 API 是子路径 `@firmenakte/api-client/v2`; 包的根导出保留 v1. 内容 客户端每个操作都有一种方法,由操作的命名 `operationId` 输入 [v2 参考](https://docs.firmenakte.at/openapi-v2.json)数字 :

```ts
import { createApiClient, isApiError } from "@firmenakte/api-client/v2";

const client = createApiClient({ apiKey: process.env.FIRMENAKTE_KEY });
const { data: company, response } = await client.getCompany({ path: { id: "fnr:56247t" } });
console.log(company.name, response.headers.get("X-Credits-Charged"));

try {
  await client.getCompany({ path: { id: "fnr:999999x" } });
} catch (error) {
  if (!isApiError(error)) throw error; // no answer: network failure, timeout or abort
  console.log(error.status, error.problem?.detail);
}
```

每种方法 `{ path, query, body, headers }` 由于操作定义了它们,加上任何 `fetch` 选项,例如 `signal`;路径参数为您编码。 2xx 回答解决 `{ data, request, response }`其它任何拒绝 `ApiError`数字 : `status`问题JSON 作为 `problem`,则 `response`。文件下载(`getExportFile`, (中文(简体) ), `getDocumentContent`, (中文(简体) ), `getLicenseExtract`采取 `parseAs: "blob"` 或者说 `"stream"`。 。 。 .

## 信贷和利率限额

API的通话使用您的账户的 每周信用, 共享所有密钥。 免费包括50, 启动器500,业务5000,和企业 商定津贴。 周一重装 协调世界时00:00. 购入的信贷从未到期,每周津贴无法支付电话费. 见 [信贷定价](https://firmenakte.at/preise/credits)。 。 。 .

操作声明 `x-credit-class` 在 OpenAPI 规格中 : `basic` 成本 1 信贷和 `expensive` 3. 收费答复包括: `X-Credits-Charged` 财务报告和审定财务报表 `X-Credits-Remaining`。 。 。 . 客户在回应中揭露了这些 `headers`数字 :

```ts
const response = await api.v1BusinessesList();
const charged = response.headers.get("X-Credits-Charged");
const remaining = response.headers.get("X-Credits-Remaining");
```

最终点响应成本入计量,甚至 `400` 或者说 `404`认证失败, `401`, (中文(简体) ), 以 `429`,服务器错误, `5xx`,费用不计入. 信用用尽收益 `429`,一个 `error` 消息从 `Credits aufgebraucht`, (中文(简体) ), 财务报告和审定财务报表 `Retry-After` 以秒计,直到协调世界时00:00。 单独的爆发限制返回 `Retry-After: 60`。较长的等待意味着信用耗尽;接近星期一,检查错误 消息,因为重置可能距离60秒或更短.

## 文档

完整的 API 引用、认证和指南 : **[https://docs.firdenakte.at 互联网档案馆的存檔,存档日期2013-12-21](https://docs.firmenakte.at/)**

## 常见问题

### @firmenakte/api-client 是什么？

Firmenakte API 的脚本/ JavaScript 客户端

### 如何安装 @firmenakte/api-client？

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

### @firmenakte/api-client 支持 TypeScript 吗？

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

### @firmenakte/api-client 支持 ESM 还是 CommonJS？

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

### @firmenakte/api-client 可以商用吗？

@firmenakte/api-client 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @firmenakte/api-client 的下载量有多少？

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

### @firmenakte/api-client 还在维护吗？

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