gusto

Gusto

Gusto 是一款广受欢迎的人力资源和薪资平台，可帮助中小型企业管理员工薪酬、福利和人力资源事务。人力资源从业者、企业主和员工会使用它来简化薪资管理、办理新员工入职并管理福利。

官方文档：https://developers.gusto.com/

Gusto 概览

• 员工
  • 薪资单
• 承包商
  • 薪资单
• 休假申请
• 公司
• 报告

使用 Gusto

此技能使用 Membrane CLI 与 Gusto 交互。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 等。这些类型将用于调整工具配置，使其最适合你的运行环境。

连接到 Gusto

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

membrane connection ensure "https://gusto.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（可选）— 供用户完成操作的预构建 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（操作返回的内容）。

常用操作

名称	键	描述
列出员工	list-employees	获取公司的所有员工的分页列表。
列出承包商	list-contractors	获取公司的所有承包商列表。
列出工资单	list-payrolls	获取公司的工资单列表。
列出薪资计划	list-pay-schedules	获取公司的所有薪资计划列表。
列出地点	list-locations	获取公司的所有地点列表。
列出职位	list-jobs	获取员工的所有职位列表。
列出部门	list-departments	获取公司的所有部门列表。
列出休假活动	list-time-off-activities	获取员工的休假活动列表。
获取员工	get-employee	根据员工 ID 获取特定员工的详细信息。
获取承包商	get-contractor	根据承包商 ID 获取特定承包商的详细信息。
获取工资单	get-payroll	根据工资单 ID 获取特定工资单的详细信息。
获取薪资计划	get-pay-schedule	根据薪资计划 ID 获取特定薪资计划的详细信息。
获取地点	get-location	根据地点 ID 获取特定地点的详细信息。
获取职位	get-job	根据职位 ID 获取特定职位的详细信息。
获取部门	get-department	根据部门 ID 获取特定部门的详细信息。
获取公司	get-company	获取特定公司的详细信息，包括名称、地点和其他公司信息。
创建员工	create-employee	为公司创建一名新员工。
创建承包商	create-contractor	为公司创建一名新承包商。
创建职位	create-job	为员工创建一个新职位。
创建部门	create-department	为公司创建一个新部门。

运行操作

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

传递 JSON 参数：

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

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

代理请求

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