@nemphi/sdk
的类型化TypeScript客户端 Nemphi API。零运行时
依赖关系。它使用平台 fetch． 业务工具调用使用
与产品UI相同的租户范围、策略、幂等性和操作分类账。
安装
npm install @nemphi/sdk
# or: pnpm add @nemphi/sdk / yarn add @nemphi/sdk
需要Node 20+（或任何带有global的运行时） fetch）。
快速启动
import { createClient } from "@nemphi/sdk";
const nemphi = createClient({
baseUrl: "https://api.nemphi.com",
// API key (nk_…) is tenant-bound. Session tokens (nse_…) also need tenantId.
token: process.env.NEMPHI_API_KEY!,
});
const { invoice, journal_entry } = await nemphi.postInvoice(invoiceId, {
idempotencyKey: `post-${invoiceId}`,
});
console.log(invoice.status, journal_entry.entry_number);
配置
| 选项 | 描述 |
|---|---|
baseUrl | 原料药来源，例如 https://api.nemphi.com |
token | 承载凭证：API密钥(nk_…)或会话令牌(nse_…） |
tenantId | 在使用用户会话时，租户范围的调用必需 |
headers | 每个请求的额外标头 |
fetch | 自定义 fetch （默认为全局） |
身份验证
- API密钥 是在工作区设置中创建的，并且已经绑定到一个
房客——把它们当作
token,没有tenantId需要的。 - 用户会话 两者都需要
token和tenantId（X-Tenant-Id）。
const session = createClient({
baseUrl: "https://api.nemphi.com",
token: sessionToken,
tenantId: workspaceId,
});
错误
import { ApiError } from "@nemphi/sdk";
try {
await nemphi.postInvoice(id);
} catch (err) {
if (err instanceof ApiError) {
// status, code (e.g. "approval_required"), message, body
console.error(err.status, err.code, err.message);
}
throw err;
}
它涵盖了什么
客户端镜像Nemphi web应用程序使用的HTTP界面：auth、工作区、
工具(invoke /输入的助手)、操作、运行、仪表板、邮件、CRM等等。
类型位于同一模块的客户端旁边。
设计合同见 docs/backbone.md 在单列波中(第3节，第9节
API契约)。
维护人员工作流程
网络和移动应用程序使用 workspace:*． 重建他们的SDK
pnpm build:sdk 在源代码更改之后。将SDK更改合并到 master
将它发布到npm； PUBLISHING.md 涵盖版本控制、包
检查和发布。
私人 @nemphi/admin-sdk 拥有 /v1/admin/*;这些方法不属于我们
在这个公共包裹中。