核心概念
模块
模块把 CRM、支付、飞书、企微等业务能力接入应用。
模块是可安装的业务能力包。安装模块后,应用、智能体、技能和后端服务都可以使用模块提供的能力,例如查询客户、创建订单、发送消息或调用支付。
模块类型
常见模块分为普通业务模块、HTTP 代理模块和渠道模块。普通业务模块随平台运行时部署; HTTP 代理模块把已有接口包装成模块方法;渠道模块负责微信、飞书、企微、钉钉等入口 接入。需要自动管理外部安装态资源时,由包含这些模块的 Bundle 配置生命周期插件。
通过 Bundle 安装模块
模块是 Bundle 的内部资源,不作为独立市场商品。Bundle 使用精确模块版本生成资源锁, 安装到 Runtime 时自动物化模块。已安装模块可以在工作区中查看版本、配置项和可调用方法。
配置属性
模块属性用于保存 token、租户 ID、回调地址、默认用户域等接入信息。生产配置请填写在模块属性中,不要写在页面代码或公开文案里。
调用能力
模块方法可以被智能体、技能、后端服务或页面请求调用。调用前先确认模块已安装,属性已填写,当前账号拥有访问权限。
POST /api/module/{moduleId}/methods/{methodName}先安装,再调用
应用只能调用当前工作区已安装并配置完成的模块能力。安装或修改属性后,请发起一次真实调用确认结果。
创建模块
需要把新的业务能力做成可复用模块时,请先阅读 创建模块。创建模块要同时定义属性、用户域、方法、生命周期和发布验证方式。
平台身份头是保留命名空间
模块不得声明或转发 X-Baijimu-*、X-Gateway-Module-*、X-Partner-* 请求头,也不得把普通 userId 当作当前操作者。系统模块访问平台服务时的完整身份头契约见 创建模块:系统模块访问平台服务时的身份头。