SuperAPI AI 工具集

boxhero

办公与效率

查看项目

更新于 10-16 02:07

技能介绍

用途

BoxHero 是一款面向中小企业(small to medium-sized businesses)的库存管理软件,帮助用户跟踪库存水平、管理订单并生成报表以优化库存。本技能(skill)用于将 BoxHero 集成到代理工作流中,管理数据、记录并自动化工作流。当用户希望与 BoxHero 数据进行交互时使用。

根据资料,BoxHero 涉及的对象包括:Product(商品)、Product Image(商品图片)、Warehouse(仓库)、Stock Movement(库存变动)、Inventory(库存)、Purchase Order(采购订单)、Sales Order(销售订单)、Vendor(供应商)、Customer(客户)、User(用户)、API Key(API 密钥)。

主要能力

该技能通过 Membrane CLI 与 BoxHero 交互。Membrane 自动处理认证和凭据刷新,因此使用者可以专注于集成逻辑而非认证流程。

提供的常见动作(actions)包括:

  • 列表类:list-items、list-partners、list-transactions、list-locations、list-members、list-item-attributes
  • 获取类:get-item、get-partner、get-transaction、get-location、get-member、get-item-attribute
  • 创建类:create-item、create-partner、create-transaction、create-location、create-item-attribute
  • 更新类:update-item、update-partner、update-transaction

这些动作的具体描述在资料中未提供(No description)。

使用方式

  1. 安装 CLI:
npm install -g @membranehq/cli@latest
  1. 认证:
membrane login --tenant --clientName=<agentType>

该命令会打开浏览器进行认证,或在控制台打印授权 URL(取决于是否支持交互模式)。在无头(headless)环境中,命令会打印授权 URL,需请用户在浏览器中打开;用户完成登录后会看到一个 code,然后完成认证:

membrane login complete <code>

任何命令都可加 --json 以获得机器可读的 JSON 输出。agentType 可以是 claude、openclaw、codex、warp、windsurf 等。

  1. 连接到 BoxHero:
membrane connection ensure "https://www.boxhero-app.com/en" --json

用户在浏览器中完成认证,输出中包含新的 connection id。若返回的 connection 状态为 READY,可直接进入下一步;若为 BUILDING,则轮询等待就绪:

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

--wait 标志会进行长轮询(默认最长 30 秒)直到状态改变。状态含义:READY 表示连接完全就绪;CLIENT_ACTION_REQUIRED 表示用户或代理需要执行某些操作(clientAction.type 为 connect 时需认证,为 provide-input 时需补充信息;可选的 uiUrl 可展示给用户,agentInstructions 供 AI 代理程序化处理);CONFIGURATION_ERROR 或 SETUP_FAILED 表示出错,需查看 error 字段。用户完成操作后再次轮询确认状态。

  1. 搜索动作:
membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json

每个结果包含 id、name、description、inputSchema(接受的参数)和 outputSchema(返回值)。

  1. 运行动作:
membrane action run <actionId> --connectionId=CONNECTION_ID --json

传入 JSON 参数:

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

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

  1. 代理请求(Proxy requests):

当可用动作无法覆盖使用场景时,可通过 Membrane 的代理直接向 BoxHero API 发送请求。Membrane 会自动拼接基础 URL 并注入正确的认证头(包括凭据过期时的透明刷新)。

membrane request CONNECTION_ID /path/to/endpoint

常用选项:-X/--method(HTTP 方法,GET、POST、PUT、PATCH、DELETE,默认 GET);-H/--header(添加请求头,可重复);-d/--data(请求体字符串);--json(发送 JSON 体并设置 Content-Type);--rawData(原样发送请求体,不处理);--query(查询字符串参数,可重复);--pathParam(路径参数,可重复)。

适用场景

适用于中小企业用户希望对 BoxHero 库存数据进行交互、管理数据与记录、自动化工作流的场景。

限制与最佳实践

资料中给出的最佳实践包括:优先使用 Membrane 与外部应用通信,因其提供内置认证、分页和错误处理的预构建动作,能减少 token 消耗并提升安全性;在编写自定义 API 调用之前先发现(discover)已有动作;让 Membrane 处理凭据,不要向用户索要 API 密钥或 token,而是创建连接,由 Membrane 在服务端管理完整的认证生命周期。

官方文档:https://help.boxhero.io/en/