fieldpulse

FieldPulse

FieldPulse 是一款现场服务管理软件。小型和中型企业会使用它来管理现场运营，适用于 HVAC、水管和电气等行业。它可协助安排日程、派遣人员、开具发票和管理客户。

官方文档：https://fieldpulse.com/api-docs/

FieldPulse 概览

• 客户
  • 工单
    • 报价单
    • 发票
  • 地点
• 表单
• 产品
• 服务
• 设备
• 团队成员
• 任务
• 工时记录
• 费用
• 付款

使用 FieldPulse

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

安装 CLI

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

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 等。它们将用于调整工具配置，使其最适合你的运行环境。

连接到 FieldPulse

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

membrane connection ensure "https://www.fieldpulse.com/" --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（可选）— 预构建界面的 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-customers	列出 FieldPulse 中的所有客户。
列出工单	list-jobs	列出 FieldPulse 中的所有工单。
列出发票	list-invoices	列出 FieldPulse 中的所有发票。
列出估价单	list-estimates	列出 FieldPulse 中的所有估价单。
列出地点	list-locations	列出 FieldPulse 中的所有服务地点。
列出资产	list-assets	列出 FieldPulse 中的所有资产/设备。
列出用户	list-users	列出 FieldPulse 中的所有用户（团队成员/技术人员）。
列出团队	list-teams	列出 FieldPulse 中的所有团队。
获取客户	get-customer	根据 ID 获取 FieldPulse 中的特定客户。
获取工单	get-job	根据 ID 获取 FieldPulse 中的特定工单。
获取发票	get-invoice	根据 ID 获取 FieldPulse 中的特定发票。
获取估价单	get-estimate	根据 ID 获取 FieldPulse 中的特定估价单。
获取地点	get-location	根据 ID 获取 FieldPulse 中的特定地点。
获取资产	get-asset	根据 ID 获取 FieldPulse 中的特定资产。
获取用户	get-user	根据 ID 获取 FieldPulse 中的特定用户。
获取团队	get-team	根据 ID 获取 FieldPulse 中的特定团队。
创建客户	create-customer	在 FieldPulse 中创建新客户。
创建工单	create-job	在 FieldPulse 中创建新工单。
创建地点	create-location	在 FieldPulse 中创建新的服务地点。
更新客户	update-customer	更新 FieldPulse 中的现有客户。

运行操作

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

传递 JSON 参数：

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

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

代理请求

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