SuperAPI AI 工具集

lightspeed-ecom

办公与效率

查看项目

更新于 10-15 10:12

技能介绍

Lightspeed eCom 是一个电子商务平台,使企业能够创建和管理在线商店。各类规模的零售商使用它在线销售产品、管理库存并处理支付。官方文档地址为 https://developers.lightspeedhq.com/ecom/。

用途 本技能用于 Lightspeed eCom 集成,可管理数据、记录并自动化工作流。当用户希望与 Lightspeed eCom 数据交互时使用。

主要能力 集成涉及的对象包括:产品(Product)、图片(Images)、分类(Category)、品牌(Brand)、订单(Order)、客户(Customer)、博客(Blog)、博客文章(Blog Post)、页面(Page)、导航菜单(Navigation Menu)、支付方式(Payment Method)、配送方式(Shipping Method)、国家(Country)、Webhook、用户(User)、店铺(Shop)、报表(Report)。

使用方式 本技能使用 Membrane CLI 与 Lightspeed eCom 交互。Membrane 自动处理认证与凭证刷新,因此用户可专注于集成逻辑而非认证管道。

安装 CLI: npm install -g @membranehq/cli@latest

认证: membrane login --tenant --clientName=<agentType> 该命令会打开浏览器进行认证,或在控制台打印授权 URL(取决于是否支持交互模式)。无头环境:命令会打印授权 URL,请用户用浏览器打开;用户完成登录后看到代码,执行: membrane login complete <code> 任意命令加 --json 可获得机器可读的 JSON 输出。Agent 类型包括 claude、openclaw、codex、warp、windsurf 等,用于针对不同运行环境调整工具。

连接 Lightspeed eCom: 使用 membrane connection ensure 按应用 URL 或域名查找或创建连接: membrane connection ensure "https://www.lightspeedhq.com/ecom/" --json 用户在浏览器中完成认证,输出包含新的连接 id。这是获取连接最快的方式:URL 会被规范化为域名并与已知应用匹配;若未找到应用,则自动创建并构建连接器。 若返回的连接状态为 READY,跳到第 2 步。

1b. 等待连接就绪: 若连接处于 BUILDING 状态,轮询直到就绪: npx @membranehq/cli connection get <id> --wait --json --wait 标志会长轮询(最长 --timeout 秒,默认 30)直到状态变化。持续轮询直到状态不再是 BUILDING。 结果状态含义: READY — 连接已完全建立,跳到第 2 步。 CLIENT_ACTION_REQUIRED — 用户或 agent 需要执行操作,clientAction 对象描述所需操作: clientAction.type — 所需操作类型:"connect" 表示用户需要认证(OAuth、API 密钥等),涵盖初始认证与断连后的重新认证;"provide-input" 表示需要更多信息(例如连接哪个应用)。 clientAction.description — 所需操作的说明。 clientAction.uiUrl(可选)— 用户可完成操作的预构建 UI 的 URL,存在时展示给用户。 clientAction.agentInstructions(可选)— 供 AI agent 以编程方式继续的说明。 用户完成操作(例如在浏览器中认证)后,再次用 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(返回内容)。 常用动作:使用 npx @membranehq/cli@latest action list --intent=QUERY --connectionId=CONNECTION_ID --json 发现可用动作。

运行动作: membrane action run <actionId> --connectionId=CONNECTION_ID --json 传入 JSON 参数: membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}' --json 结果位于响应的 output 字段。

代理请求: 当可用动作无法覆盖用例时,可通过 Membrane 的代理直接向 Lightspeed eCom 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"。

最佳实践 始终优先使用 Membrane 与外部应用通信——Membrane 提供内置认证、分页和错误处理的预构建动作,可减少 token 消耗并使通信更安全。 先发现再构建——运行 membrane action list --intent=QUERY(将 QUERY 替换为意图)在编写自定义 API 调用前查找现有动作。预构建动作处理分页、字段映射和原始 API 调用容易遗漏的边界情况。 让 Membrane 处理凭证——绝不要向用户索要 API 密钥或令牌。改为创建连接;Membrane 在服务端管理完整的认证生命周期,本地不保存密钥。

适用场景 适用于需要与 Lightspeed eCom 数据交互的场景,例如管理产品、订单、客户、分类、品牌、博客、页面、导航菜单、支付方式、配送方式、国家、Webhook、用户、店铺和报表等数据,以及自动化相关工作流。

限制 资料未提供关于收费、价格、平台支持范围、具体效果或性能的说明,暂未提供。使用前需安装 Membrane CLI 并完成登录与连接建立;无头环境需用户手动在浏览器完成授权。