@ wardenakte/ api- 客户端
类型脚本/ Java脚本客户端 法尔梅纳克特 API (英语).
安装
npm install @firmenakte/api-client
或带pnm:
pnpm add @firmenakte/api-client
快开始
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 当呼叫者需要提前取消时, 在结束点的请求参数中:
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 参考数字 :
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. 购入的信贷从未到期,每周津贴无法支付电话费. 见 信贷定价。 。 。 .
操作声明 x-credit-class 在 OpenAPI 规格中 : basic 成本 1 信贷和
expensive 3. 收费答复包括: X-Credits-Charged 财务报告和审定财务报表 X-Credits-Remaining。 。 。 .
客户在回应中揭露了这些 headers数字 :
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