SuperAPI AI 工具集
合作ENAI 行业资讯收藏
Skill 广场shipamax

shipamax

办公与效率

查看项目

更新于 10-16 01:56

技能介绍

用途

Shipamax 是一个用于自动化货运代理与航运业务的平台，主要面向货运代理、发货方及其他物流企业，帮助其简化运营流程。该平台可以从发票、订舱确认等文档中提取数据，并将其集成到其他系统中。

本技能用于通过 Membrane CLI 与 Shipamax 进行交互，从而管理数据、记录并自动化工作流。当用户需要与 Shipamax 数据进行交互时适用。

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

主要能力与核心对象

根据资料，Shipamax 涉及的核心对象包括：

  • Booking（订舱）
  • Document（文档）
  • Forwarder（货运代理）
  • Shipment（货运）
  • User（用户）

可按需要使用的操作名称与参数进行操作。

使用方式

该技能通过 Membrane CLI 与 Shipamax 交互。Membrane 会自动处理身份验证与凭据刷新，因此使用者可以专注于集成逻辑，而不必处理认证相关的底层细节。

安装 CLI

在终端中运行以下命令安装 Membrane CLI：

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 等，用于针对所用环境调整工具。

连接到 Shipamax

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

membrane connection ensure "https://shipamax.com" --json

用户在浏览器中完成身份验证。输出中包含新的连接 id。

这是获取连接的最快方式。URL 会被规范化为域名并与已知应用匹配。如果未找到对应应用，则会创建一个，并自动构建连接器。

如果返回的连接状态为 "READY"，直接跳到搜索动作步骤。

等待连接就绪

如果连接处于 BUILDING 状态，轮询直到就绪：

npx @membranehq/cli connection get <id> --wait --json

--wait 标志会进行长轮询（最长 --timeout 秒，默认 30），直到状态改变。持续轮询直到状态不再是 BUILDING。

状态含义：

  • READY — 连接已完全设置好。
  • CLIENT_ACTION_REQUIRED — 用户或 Agent 需要执行某项操作。clientAction 对象描述所需操作：
    • clientAction.type — 所需操作类型："connect" 表示用户需要身份验证（OAuth、API key 等），涵盖初次认证与断开连接后的重新认证；"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 的代理直接向 Shipamax 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 消耗并使通信更安全。
  • 先发现再构建——运行 membrane action list --intent=QUERY（将 QUERY 替换为你的意图）来查找现有动作，然后再编写自定义 API 调用。预构建动作会处理原始 API 调用容易遗漏的分页、字段映射和边界情况。
  • 让 Membrane 处理凭据——绝不要向用户索要 API key 或 token。改为创建连接；Membrane 在服务端管理完整的认证生命周期，本地不保存任何密钥。