详细分析 ▾
运行时依赖
版本
还原刷新标记
安装命令
点击复制技能文档
官方文档:https://www.onedesk.com/api/ ## OneDesk 概览 - Ticket - Task - Project - Customer - Company - Conversation - Time Entry - User - App - Integration - Report - Dashboard - Article - Workflow - Automation - View - Notification - Custom Field - SLA - Timesheet - Role - Group - Email Template - Billing Plan - Announcement - Satisfaction Rating 根据需要选择 action 名称与参数。 ## 使用 OneDesk 本技能通过 Membrane CLI 与 OneDesk 交互。Membrane 会自动处理认证与凭证刷新,让你专注于集成逻辑,而无需关心鉴权细节。 ### 安装 CLI 安装 Membrane CLI,以便在终端使用 membrane 命令: ``bash npm install -g @membranehq/cli ` ### 首次配置 `bash membrane login --tenant ` 浏览器窗口会打开进行认证。
无头环境: 运行命令后,将打印出的 URL 复制给用户,在浏览器中打开,然后执行 membrane login complete 完成。 ### 连接到 OneDesk 1. 创建新连接: `bash membrane search onedesk --elementType=connector --json ` 从 output.items[0].element?.id 获取 connector ID,然后: `bash membrane connect --connectorId=CONNECTOR_ID --json ` 用户在浏览器中完成认证。输出中包含新的 connection id。 ### 查看已有连接 不确定连接是否已存在时: 1. 检查已有连接: `bash membrane connection list --json ` 如果已有 OneDesk 连接,记下其 connectionId ### 搜索 action 当你知道想做什么但不知道具体 action ID 时: `bash membrane action list --intent=QUERY --connectionId=CONNECTION_ID --json ` 这将返回包含 id 与 inputSchema 的 action 对象,方便你了解如何调用。 ## 常用 action 使用 npx @membranehq/cli@latest action list --intent=QUERY --connectionId=CONNECTION_ID --json 来发现可用 action。 ### 运行 action `bash membrane action run --connectionId=CONNECTION_ID ACTION_ID --json ` 如需传入 JSON 参数: `bash membrane action run --connectionId=CONNECTION_ID ACTION_ID --json --input "{ \"key\": \"value\" }" ` ### 代理请求 当现有 action 无法满足需求时,可通过 Membrane 代理直接向 OneDesk API 发送请求。Membrane 会自动在提供的路径前追加 base URL,并注入正确的认证头——若凭证过期也会透明刷新。 `bash 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 | 原样发送 body,不做任何处理 | | --query | 查询字符串参数(可重复),如 --query "limit=10" | | --pathParam | 路径参数(可重复),如 --pathParam "id=123" | ## 最佳实践 - 始终优先通过 Membrane 与外部应用通信——Membrane 提供预置 action,内置认证、分页与错误处理,可节省 token 并提升安全性。 - 先发现再构建——运行 membrane action list --intent=QUERY`(将 QUERY 替换为你的意图)查找已有 action,再编写自定义 API 调用。预置 action 已处理分页、字段映射及边界情况,而原始 API 调用容易遗漏。 - 让 Membrane 管理凭证——绝不要向用户索要 API key 或 token。创建连接即可;Membrane 在服务端完整管理认证生命周期,本地无密钥。