插件开发入门
插件可通过 HTTP、WebSocket 或 IPC 接入框架,按插件权限操作当前框架内的账号。
Node.js 插件可使用 SDK 接入说明,其中包含各连接方式、调用与事件示例,以及 SDK 下载入口。
选择接入方式
| 方式 | 连接方向 | 用途 |
|---|---|---|
| HTTP | 插件请求框架的 HTTP 服务 | 调用接口,不通过此连接订阅事件 |
| 正向 WebSocket | 插件连接框架 | 调用接口并接收已授权事件 |
| 反向 WebSocket | 框架连接插件 | 插件有可供框架连接的 WebSocket 服务 |
| 本地 IPC | 框架启动插件,通过标准输入输出通信 | 导入插件包,在框架中管理运行状态、配置和日志 |
创建服务
在管理后台的“插件”中创建服务,选择接入方式,配置服务名称、令牌以及该方式所需的监听端口或连接地址,然后启用服务。
将地址和令牌配置到独立运行的插件中。正向 WebSocket 连接后发送认证帧;HTTP 每次请求携带认证头;反向 WebSocket 由插件服务端校验框架的握手头。完整格式与可直接使用的示例见通信协议。
选择账号与调用接口
账号接口使用 self_id 和 protocol_id 共同选择实例。protocol_id 来自 get_protocol_list,必须显式传入,0 也是有效值。账号须属于当前框架,大多数业务接口要求账号在线。
通过 API 目录查找接口的参数、返回值和示例。WebSocket 请求通过 id 对应响应;收到 ok: false 时读取 error,不要自动重试发消息、付款或审批等操作。
权限与兼容
IPC 插件须声明需要的接口和事件权限,安装包格式见插件导入。使用 client_type、forProtocol 或 action_stream 的插件应按通信协议调整参数和消息格式。外部服务令牌只保存在可信插件的受保护配置中,不放入公开网页。
