外部 REST 集成(API 密钥)
外部 REST 集成是一道受控的「门」,让另一套系统(ERP、网站后端、1C 或集成中间层、自有应用)能够通过标准 API 和访问密钥,在 LadVen OS 中创建和更新任务与销售机会。整个过程中,没有人会传递登录名和密码,也不会以管理员身份运行。
每次调用都以一个独立的服务账号(机器人)身份执行,并且只拥有最低限度的必要权限:只能做你允许的操作,且只能在你设定的部门、项目、管道和阶段内执行。所有请求都会经过门户的常规规则——访问控制、校验、自动化、通知——并被记录到日志中,每个集成的日志都可以查看。
集成连接在集成中心里一次性添加(CRM → 集成板块,路由 /crm/integrations)。
何时使用
当「另一套系统里发生了某件事,而 LadVen OS 中应当自动出现一个任务或销售机会」时,就需要 REST 集成。典型场景:
- ERP 或网站在收到订单、申请或工单时创建任务或客户咨询;
- 自有应用让任务和销售机会与外部数据库保持同步;
- 随着另一端工作的推进,外部系统附加文件、留下评论、记录工时,或推动销售机会沿阶段流转。
它与表单和 webhook 有何不同:网站表单和 webhook 是单向地把申请接入 CRM。REST 集成则是程序化的双向连接:外部系统既读取(获取任务、销售机会、历史记录),也写入(创建和更新)。门户本身不会通过这个连接对外发送 webhook——是外部一方主动来访问门户。
如何设置
集成连接通过分步向导创建(CRM → 集成板块 → 添加「外部 REST 集成」)。按步骤、用业务化的语言来说:
- 名称与启用状态。 给集成起一个清晰的名字,并决定是否立即启用。可以马上运行一次连接检查。
- 服务账号。 选择现有机器人,或直接在向导中新建一个(名称和登录名)。它不是员工,也不是管理员:集成以它的身份运行。如果选择了拥有管理员权限的账号,向导会发出提示——这是有意为之,集成只授予最低限度的权限。
- 场景与权限级别。 按任务选择一组操作:「任务与 CRM」「仅任务」或「仅 CRM」。然后选择权限级别:只读、创建与编辑,或管理。权限会在颁发密钥之前应用到服务账号上。
- 允许的操作。 勾选集成可以执行的具体操作。原则是最低限度的必要:只开启确实需要的。凡是未勾选的操作,都会在执行前被拒绝。
- 范围。 将集成限制在所需的部门、项目、管道和阶段内。这是叠加在账号权限之上的一道边界:即使是被允许的操作,也只会在设定的范围内生效。
- 字段与限额。 设定集成可以修改哪些任务和销售机会字段、每分钟的请求限额和允许的瞬时峰值,以及允许发起调用的 IP 地址白名单。
- 创建密钥与检查。 保存后,门户会在结果页面上仅一次性显示访问密钥,并附带复制按钮。在这里也可以运行连接检查。
创建完成后,连接会带有一份请求日志:调用了哪些操作、结果如何,以及每次调用的详情(记录中的敏感数据已被隐藏)。
安全性与访问密钥
REST 集成建立在最小权限原则之上——这对企业主很重要:
- 密钥只显示一次。 复制后请立即保存到密钥管理器中。门户不会再次显示这个密钥,也不会以明文形式存储它。如果需要更换密钥,请重新为该连接走一遍向导,重新颁发密钥。
- 独立的服务账号。 集成不以某个人或管理员身份运行;它有自己的职责范围和自己的权限。
- 访问边界。 允许的操作、范围(部门、项目、管道、阶段)、字段白名单、请求限额和 IP 白名单,共同限定了集成能做什么、能从哪里发起。
- 日志。 每次调用都有记录——可以追查谁通过集成改动了什么。
绝不要在截图中展示或公开真实的密钥、授权请求头、白名单中的 IP 地址或服务账号的登录名。配图请使用明显虚构的示例值。
常见错误
- 给集成分配了管理员账号,而不是服务机器人。
- 开启了超过所需的操作,而没有遵循最低限度的必要原则。
- 创建时没有复制那一次性显示的密钥。
- 没有设置 IP 白名单和请求限额。
- 范围设得过宽——整个门户,而不是真正需要的那一个管道。
- 指望门户自己开始对外发送 webhook:集成靠的是入站调用,由外部系统来访问门户。
如何验证结果
- 在向导末尾运行连接检查(或勾选立即运行检查)。
- 确认连接卡片显示为启用且状态正常。
- 查看请求日志——其中应当有成功的调用。
- 检查测试用的任务或销售机会是否已生成,且负责人、管道和阶段都正确,自动化和通知也都照常运行。