edusign

Edusign

Edusign 是一个用于创建和管理数字签名及工作流的平台，主要应用于教育领域。它能帮助教育机构简化文件签署流程，例如入学表格、成绩单和合同的签署。

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

Edusign 概览

• Document
  • Recipient
• Template

使用 Edusign

此技能使用 Membrane CLI 与 Edusign 交互。Membrane 会自动处理身份验证和凭据刷新，让你可以专注于集成逻辑，而不是身份验证相关的繁琐工作。

安装 CLI

安装 Membrane CLI，以便在终端中运行 membrane：

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 等。系统会据此调整工具，以便更好地配合你的运行环境。

连接到 Edusign

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

membrane connection ensure "https://edusign.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-students	获取所有在读学生。
列出教授	list-professors	获取所有教授
列出课程	list-courses	获取所有课程，可按日期范围和状态筛选
列出小组	list-groups	获取所有小组
列出教室	list-classrooms	获取所有教室
列出培训项目	list-trainings	获取所有培训项目
列出文档	list-documents	获取所有文档
列出问卷	list-surveys	获取所有问卷
列出问卷模板	list-survey-templates	获取所有问卷模板
按 ID 获取学生	get-student-by-id	根据 Edusign ID 获取学生
按 ID 获取教授	get-professor-by-id	根据 Edusign ID 获取教授
按 ID 获取课程	get-course-by-id	根据 Edusign ID 获取课程
按 ID 获取小组	get-group-by-id	根据 Edusign ID 获取小组
按 ID 获取问卷	get-survey-by-id	根据 ID 获取问卷
创建学生	create-student	在 Edusign 中创建新学生
创建教授	create-professor	在 Edusign 中创建新教授
创建课程	create-course	在 Edusign 中创建新课程／课次
创建小组	create-group	在 Edusign 中创建新小组
创建教室	create-classroom	创建新教室
更新课程	update-course	更新现有课程

运行操作

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

传递 JSON 参数：

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

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

代理请求

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