beeswax

Beeswax

Beeswax 是一个程序化广告平台。它允许营销人员和代理机构构建并自定义自己的需求方平台（DSP），以购买在线广告。

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

Beeswax 概览

• Campaign
  • Creative
• Line Item
• Targeting Template
• Report
• User
• Audience
• Category
• Key Value
• Pixel
• Data Provider
• Currency
• Bulk Upload
• Change Log

根据需要使用操作名称和参数。

使用 Beeswax

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

连接到 Beeswax

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

membrane connection ensure "https://www.beeswax.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-users	获取账户中的用户列表
列出明细项	list-line-items	获取明细项列表。
列出广告系列	list-campaigns	获取广告系列列表
列出创意素材	list-creatives	获取创意素材列表。
列出广告主	list-advertisers	获取账户中的广告主列表
列出细分受众	list-segments	获取受众细分列表
获取账户	get-account	获取当前账户信息
获取明细项	get-line-item	根据 ID 获取指定的明细项
获取广告系列	get-campaign	根据 ID 获取指定的广告系列
获取创意素材	get-creative	根据 ID 获取指定的创意素材
获取广告主	get-advertiser	根据 ID 获取指定的广告主
获取细分受众	get-segment	根据 ID 获取指定的细分受众
创建明细项	create-line-item	创建新的明细项。
创建广告系列	create-campaign	创建新的广告系列
创建创意素材	create-creative	创建新的创意素材。
创建广告主	create-advertiser	创建新的广告主
创建细分受众	create-segment	创建新的受众细分
更新明细项	update-line-item	更新现有明细项
更新广告系列	update-campaign	更新现有广告系列
更新创意素材	update-creative	更新现有创意素材

运行操作

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

传递 JSON 参数：

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

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

代理请求

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