firmao

Firmao

Firmao 是一款 CRM 和项目管理软件，旨在帮助中小型企业管理销售、项目和客户关系。企业家、自由职业者和小型团队使用它来简化工作流并改善协作。

官方文档：https://firmao.net/api/

Firmao 概览

• 客户
• 发票
  • 发票项目
• 产品
• 服务
• 任务
• 时间跟踪
• 用户

使用 Firmao

此技能使用 Membrane CLI 与 Firmao 交互。Membrane 会自动处理身份验证和凭据刷新，因此你可以专注于集成逻辑，而不必操心身份验证相关的底层工作。

安装 CLI

安装 Membrane CLI，以便从终端运行 membrane：

npm install -g @membranehq/cli@latest

身份验证

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

根据是否支持交互模式，这会打开浏览器进行身份验证，或在控制台中打印授权 URL。

**无头环境：**命令会打印授权 URL。请让用户在浏览器中打开该 URL。用户完成登录后会看到一个代码，请使用以下命令完成操作：

membrane login complete <code>

在任何命令中添加 --json，即可输出机器可读的 JSON。

Agent 类型：claude、openclaw、codex、warp、windsurf 等。这些类型将用于调整工具，使其最适合你的运行环境。

连接到 Firmao

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

membrane connection ensure "https://firmao.net/" --json

用户在浏览器中完成身份验证。输出中包含新连接的 ID。

这是获取连接最快的方式。URL 会被规范化为域名，并与已知应用进行匹配。如果找不到对应应用，系统会创建一个应用并自动构建连接器。

如果返回的连接具有 state: "READY"，请跳到步骤 2。

1b. 等待连接就绪

如果连接处于 BUILDING 状态，请轮询直到连接就绪：

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

--wait 标志会进行长轮询（最长等待 --timeout 秒，默认值为 30），直到状态发生变化。请持续轮询，直到 state 不再是 BUILDING。

当前状态会告诉你接下来该怎么做：

• READY — 连接已完成设置。请跳到步骤 2。

• CLIENT_ACTION_REQUIRED — 用户或 Agent 需要执行某项操作。clientAction 对象会描述所需操作：

  • clientAction.type — 所需操作的类型：
    • "connect" — 用户需要进行身份验证（OAuth、API 密钥等）。这包括首次身份验证，以及已断开连接时重新进行身份验证。
    • "provide-input" — 需要提供更多信息（例如要连接的应用）。
  • clientAction.description — 对所需操作的说明，供人阅读。
  • clientAction.uiUrl（可选）— 用户可在其中完成操作的预建 UI URL。如果存在，请向用户显示该 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（操作返回的内容）。

常用操作

名称	键	描述
列出文档	list-documents	从 Firmao 获取分页的文档/文件列表
列出销售备注	list-sales-notes	从 Firmao 获取分页的销售备注列表
列出销售机会	list-sales-opportunities	从 Firmao 获取分页的销售机会列表
列出报价	list-offers	从 Firmao 获取分页的报价列表
列出发票	list-invoices	从 Firmao 获取分页的发票（交易）列表
列出产品	list-products	从 Firmao 获取分页的产品列表
列出任务	list-tasks	从 Firmao 获取分页的任务列表
列出项目	list-projects	从 Firmao 获取分页的项目列表
列出联系人	list-contacts	从 Firmao 获取分页的联系人列表
列出客户	list-customers	从 Firmao 获取分页的客户（交易对手）列表
获取销售机会	get-sales-opportunity	按 ID 获取单个销售机会
获取报价	get-offer	按 ID 获取单个报价
获取发票	get-invoice	按 ID 获取单张发票
获取产品	get-product	按 ID 获取单个产品
获取任务	get-task	按 ID 获取单个任务
获取项目	get-project	按 ID 获取单个项目
获取联系人	get-contact	按 ID 获取单个联系人
获取客户	get-customer	按 ID 获取单个客户
创建客户	create-customer	在 Firmao 中创建新客户（交易对手）
创建发票	create-invoice	在 Firmao 中创建新发票

运行操作

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

传递 JSON 参数：

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

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

代理请求

如果现有操作无法满足您的使用场景，可以通过 Membrane 的代理直接向 Firmao 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 提供内置身份验证、分页和错误处理的预构建操作。这样可以减少令牌消耗，并使通信更加安全。
• 先发现，再构建 — 编写自定义 API 调用前，运行 membrane action list --intent=QUERY（将 QUERY 替换为您的意图）查找现有操作。预构建操作可以处理分页、字段映射和原始 API 调用无法覆盖的边缘情况。
• 让 Membrane 管理凭据 — 切勿向用户索取 API 密钥或令牌。请改为创建连接；Membrane 会在服务器端管理完整的身份验证生命周期，无需本地密钥。