安装
npm install @figena/npm即将推出
以下为示意示例,最终 API 以发布版本为准。
npm 包设计为覆盖的能力
覆盖全量产品能力访问,并提供面向自动化与 Agent 的关键原语。
全量产品能力访问
- 覆盖 Figena 核心功能的读写访问——预约、招聘、客户、供应商、项目、库存、消息、交易、循环、里程、AI 等,并持续扩展。
- 一致的筛选与分页能力
- 面向批处理的操作与组合调用模式
- 与角色/权限范围一致的访问建议
认证与安全
- 更安全的凭证处理模式
- 请求签名与校验辅助
- Webhook 签名验证工具
- 最小权限实践建议
核心资源
- 结构化读写操作
- 筛选与分页辅助
- 一致的校验与错误
- 可预测的返回结构
自动化能力
- 事件/Webhook 处理模式
- 幂等性辅助
- 适配任务队列的重试语义
- 便于审计的元数据字段
开发体验
- TypeScript 优先的 API 设计
- 示例与模板工程
- 更易读的日志与调试建议
- 遵循 SemVer 的版本策略
以下内容可能会在上线前调整。
快速预览
以下为示意示例,最终 API 以发布版本为准。
安装
npm install @figena/npm初始化
import { FigenaClient } from '@figena/npm'\n\nconst client = new FigenaClient({\n apiKey: process.env.FIGENA_API_KEY\n})\n\n// 示例请求(仅示意)\nawait client.ping()Webhook
import { verifyWebhookSignature } from '@figena/npm/webhooks'\n\nconst isValid = verifyWebhookSignature({\n payload,\n signature,\n secret: process.env.FIGENA_WEBHOOK_SECRET\n})\n\nif (!isValid) throw new Error('Invalid signature')