@ghxstship/xos-sdk (英语)
用于XOS公共API的TypeScript SDK. 模型,方法签名和操作表都是由OpenAPI v1文档所生成的,因此API参考文献中的每一个操作都是被打出的方法. 它运行于Node.js 22.12或后期,在浏览器和边缘运行时段,没有依赖性.
npm install @ghxstship/xos-sdk
使用
import { XosClient } from "@ghxstship/xos-sdk";
const xos = new XosClient({
baseUrl: "https://api.ghxstship.tech/v1",
apiKey: process.env.XOS_API_KEY,
});
const { data: project, etag } = await xos.projects.get(projectId);
await xos.projects.update(projectId, { name: "Harborfront Fall Series" }, { ifMatch: etag! });
for await (const po of xos.purchaseOrders.listAll({ filter: { po_state: { eq: "Approved" } } })) {
console.log(po.po_number);
}
- POST 方法发送
Idempotency-Key并在复试时重新使用. - 需要更新
ifMatch; Stale ETag 失败XosPreconditionFailedError。 。 。 . - 问题答案按类型提出
XosApiError子类,例如XosValidationError财务报告和审定财务报表XosNotFoundError。 。 。 . - 费率限额和
Retry-After我很荣幸maxRetries(违约2)和timeoutMs(默认3000).
使用 @ghxstship/xos-sdk/webhooks 切入点 :
import { verifyWebhookSignature } from "@ghxstship/xos-sdk/webhooks";
const result = await verifyWebhookSignature({
payload: rawBody, // the body exactly as received
header: request.headers.get("XOS-Signature") ?? "",
secret: process.env.XOS_WEBHOOK_SECRET!,
});
文档
- 指南 : 类型脚本 SDK
- API 参考文件: Docs 站点,来自
packages/api/openapi/v1.json
版本
软件包版本遵循了 XOS 发布( )v4.0.0 发表 4.0.0) (中文(简体) ). 内部 /v1 aPI只是添加了变化,所以一个更新的SDK继续针对每个操作的更老的服务器工作,两者都知道.
许可证
麻省理工学院. 见 自由主义XOS平台本身为AGPL-3.0-只.