acuity-scheduling

Acuity Scheduling

Acuity Scheduling 是一款工具，帮助企业为客户提供在线预约服务。它适用于沙龙、美容师和顾问等服务型企业，可用于管理可预约时间和预订。

官方文档：https://developers.squarespace.com/acuity-scheduling-api

Acuity Scheduling 概览

• 预约
  • 预约类型
• 日历
• 课程
• 套餐
• 礼品卡
• 订阅
• 用户
• 报告

按需使用操作名称和参数。

使用 Acuity Scheduling

此技能使用 Membrane CLI 与 Acuity Scheduling 交互。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 等。系统会据此调整工具，以便更好地适配你的运行环境。

连接 Acuity Scheduling

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

membrane connection ensure "https://www.acuityscheduling.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 地址，用户可在此完成操作。如果存在，请向用户展示。
  • 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-appointments	获取已认证用户的预约列表，可选择筛选
列出客户	list-clients	获取客户列表，可按姓名、电子邮件或电话号码筛选
列出预约类型	list-appointment-types	获取账户中配置的所有预约类型
列出日历	list-calendars	获取已认证用户的所有日历
列出时间段屏蔽	list-blocks	获取日历中被屏蔽的时间段列表
创建预约	create-appointment	创建新预约
创建客户	create-client	创建新客户
创建时间段屏蔽	create-block	创建新的屏蔽时间段
更新预约	update-appointment	更新现有预约
更新客户	update-client	更新现有客户
获取预约	get-appointment	根据 ID 获取单个预约
获取时间段屏蔽	get-block	根据 ID 获取单个屏蔽时间段
取消预约	cancel-appointment	取消现有预约
删除客户	delete-client	根据 ID 删除客户
删除时间段屏蔽	delete-block	删除被屏蔽的时间段
获取可用时段	get-available-times	获取指定日期的可用时段
获取可用日期	get-available-dates	获取可预约的日期
重新安排预约	reschedule-appointment	将现有预约改期至新的日期和时间
列出表单	list-forms	获取账户中配置的预约登记表单列表
获取当前用户	get-me	获取当前已认证用户的信息

运行操作

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

传递 JSON 参数：

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

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

代理请求

当可用操作无法满足你的使用需求时，可以通过 Membrane 的代理直接向 Acuity Scheduling 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 会在服务端管理完整的身份验证生命周期，不需要本地密钥。