SuperAPI AI 工具集

erpnext

办公与效率

查看项目

更新于 10-15 09:22

技能介绍

用途

ERPNext 是一款开源 ERP 系统,帮助企业管理会计、制造、CRM 等多种业务运营,适合寻求一体化平台以简化工作流的中小型企业。本技能用于与 ERPNext 数据交互,例如管理公司信息。

官方文档:https://docs.erpnext.com/

主要能力

本技能通过 Membrane CLI 与 ERPNext 交互。Membrane 自动处理认证与凭证刷新,因此使用者可以专注于集成逻辑,而无需处理认证管道。

ERPNext 涉及的对象包括:Document、Document Type、Report、Dashboard、Customize Form、Print Format、Module、Workspace、User、Email Account、Notification、Assignment、ToDo、Note、File、Data Import、Bulk Update。

常用操作(action)包括:

  • 通用操作:List Documents(列出任意 DocType 的文档)、Get Document(按名称/ID 获取任意 DocType 的文档)、Create Document(创建任意 DocType 的新文档)、Update Document(更新任意 DocType 的现有文档)。
  • 客户:List Customers、Get Customer。
  • 物料:List Items、Get Item。
  • 销售订单:List Sales Orders、Get Sales Order。
  • 销售发票:List Sales Invoices、Get Sales Invoice。
  • 采购订单:List Purchase Orders、Get Purchase Order。
  • 供应商:List Suppliers、Get Supplier。
  • 线索:List Leads、Get Lead。
  • 员工:List Employees、Get Employee。

列表类操作支持可选的过滤与分页。

使用方式

安装 CLI

在终端中运行:

npm install -g @membranehq/cli@latest

认证

membrane login --tenant --clientName=<agentType>

该命令会打开浏览器进行认证,或在控制台打印授权 URL(取决于是否支持交互模式)。

无头环境:命令会打印授权 URL,请让用户在浏览器中打开。用户完成登录后会看到一段代码,然后执行:

membrane login complete <code>

任意命令添加 --json 可获得机器可读的 JSON 输出。

Agent Types:claude、openclaw、codex、warp、windsurf 等,用于针对不同运行环境调整工具。

连接 ERPNext

使用 membrane connection ensure 按应用 URL 或域名查找或创建连接:

membrane connection ensure "https://erpnext.com" --json

用户在浏览器中完成认证。输出包含新的连接 id。这是获取连接最快的方式。URL 会被规范化为域名并与已知应用匹配;若未找到应用,则会创建一个并自动构建连接器。

如果返回的连接状态为 READY,跳到第 2 步。

1b. 等待连接就绪

如果连接处于 BUILDING 状态,轮询直到就绪:

npx @membranehq/cli connection get <id> --wait --json

--wait 标志会进行长轮询(最长 --timeout 秒,默认 30),直到状态改变。持续轮询直到状态不再是 BUILDING。

结果状态含义:

  • READY — 连接已完全建立,跳到第 2 步。
  • CLIENT_ACTION_REQUIRED — 用户或代理需要执行操作。clientAction 对象描述所需操作:
    • clientAction.type — 所需操作类型:"connect" 表示用户需要认证(OAuth、API key 等),涵盖初始认证与断连后的重新认证;"provide-input" 表示需要更多信息(例如连接哪个应用)。
    • clientAction.description — 人类可读的说明。
    • clientAction.uiUrl(可选)— 用户可完成操作的预构建 UI 的 URL,存在时展示给用户。
    • clientAction.agentInstructions(可选)— 供 AI 代理以编程方式继续的说明。
  • 用户完成操作(例如在浏览器中认证)后,再次用 membrane connection get <id> --json 轮询,检查状态是否变为 READY。
  • CONFIGURATION_ERROR 或 SETUP_FAILED — 出现问题,检查 error 字段了解详情。

搜索操作

使用自然语言描述你想做的事情进行搜索:

membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json

应始终在特定连接的上下文中搜索操作。每个结果包含 id、name、description、inputSchema(操作接受的参数)和 outputSchema(返回内容)。

运行操作

membrane action run <actionId> --connectionId=CONNECTION_ID --json

传入 JSON 参数:

membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}' --json

结果位于响应的 output 字段中。

代理请求

当可用操作无法覆盖用例时,可通过 Membrane 的代理直接向 ERPNext API 发送请求。Membrane 会自动将基础 URL 追加到你提供的路径,并注入正确的认证头——包括凭证过期时的透明刷新。

membrane request CONNECTION_ID /path/to/endpoint

常用选项:

  • -X, --method:HTTP 方法(GET、POST、PUT、PATCH、DELETE),默认 GET。
  • -H, --header:添加请求头(可重复),例如 -H "Accept: application/json"。
  • -d, --data:请求体(字符串)。
  • --json:发送 JSON 体并设置 Content-Type: application/json 的简写。
  • --rawData:按原样发送请求体,不做任何处理。
  • --query:查询字符串参数(可重复),例如 --query "limit=10"。
  • --pathParam:路径参数(可重复),例如 --pathParam "id=123"。

适用场景

适用于需要通过 AI 代理或命令行与 ERPNext 数据交互的场景,例如查询客户、物料、销售订单、销售发票、采购订单、供应商、线索、员工等记录,创建或更新任意 DocType 的文档,以及在预置操作不足时直接调用 ERPNext API。

限制与最佳实践

  • 应优先使用 Membrane 与外部应用通信——Membrane 提供内置认证、分页和错误处理的预构建操作,可减少 token 消耗并提升通信安全性。
  • 先发现再构建——运行 membrane action list --intent=QUERY(将 QUERY 替换为你的意图)查找现有操作,再编写自定义 API 调用。预构建操作会处理原始 API 调用容易遗漏的分页、字段映射和边界情况。
  • 让 Membrane 处理凭证——不要向用户索要 API key 或 token。改为创建连接;Membrane 在服务端管理完整的认证生命周期,本地不保存密钥。
  • 关于具体收费、价格、平台支持范围等信息,资料暂未提供。