footprint

Footprint

Footprint 是一个可持续发展管理平台，企业可借助它跟踪、分析并减少自身对环境的影响。它帮助公司衡量碳足迹、设定可持续发展目标，并报告进展。

官方文档：https://usefootprint.com/docs

Footprint 概览

• 项目
  • Footprint
• 足迹
• 用户
• 模板
• 集成
• 通知
• 评论
• 附件
• 已保存的视图
• 报告
• 仪表板
• 审计日志
• 工作区
• 角色
• 设置
• 订阅
• 发票
• API 密钥
• 数据导出
• 数据映射
• 数据转换
• AI Agent
• 提示词
• 模型
• 凭据
• 大模型提供商
• 提示词版本
• 提示词测试
• 提示词评估
• 提示词流程
• 提示词模板
• 提示词变量
• 提示词结果
• 数据集
• 数据标签
• 模型端点
• 模型部署
• 基准测试
• 实验
• A/B 测试
• 反馈
• 指标
• 解释
• 数据漂移
• 概念漂移
• 性能监控
• 偏见检测
• 公平性评估
• 不利结果
• 数据质量
• 数据验证
• 数据异常
• 数据完整性
• 数据治理
• 元数据
• 数据沿袭
• 访问控制
• 隐私政策
• 合规性
• 法规
• 风险评估
• 安全性
• 漏洞
• 事件
• 灾难恢复
• 业务连续性
• 变更管理
• 配置管理
• 发布管理
• 部署流水线
• 基础设施
• 服务器
• 数据库
• 网络
• 存储
• 防火墙
• 负载均衡器
• 虚拟机
• 容器
• Kubernetes
• 云服务提供商
• 域名
• DNS 记录
• SSL 证书
• API 网关
• 消息队列
• 缓存
• 搜索索引
• 监控工具
• 日志工具
• 告警工具
• 备份
• 恢复
• 归档
• 数据保留
• 数据销毁

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

使用 Footprint

此技能使用 Membrane CLI 与 Footprint 交互。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 等。系统会根据这些类型调整工具配置，以便与您的执行环境配合使用。

连接到 Footprint

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

membrane connection ensure "https://www.onefootprint.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（操作返回的内容）。

常用操作

使用 npx @membranehq/cli@latest action list --intent=QUERY --connectionId=CONNECTION_ID --json 发现可用操作。

运行操作

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

传递 JSON 参数：

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

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

代理请求

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