新手入门指南
1. 概述
本文将对「自建插件」的开发流程和新手学习路径进行介绍，从基础开发到实战案例，从 0 到 1 带您玩转「自建插件」。
2. 搭建流程
3. 学习路径
您可以通过如下路径的文档进行「自建插件」的学习，并通过实战案例进一步了解该功能的实际应用。
学习阶段 | 文档 | 内容简介 |
快速上手 | 了解如何创建「自建插件」，以及其详细的开发步骤 | |
熟练掌握 | 掌握自建插件设计过程中的核心功能。完成学习后，便可以根据企业需求开发插件，提高企业业务管理和协作效率。 | |
实战案例 | 根据自身需求，选取实战案例进行深度学习。了解自建插件从需求提出到开发设计的闭环链路。 | |
问题排查 | 「自建插件」开发过程中的常见问题汇总 |
4. 教学视频
除了上述文档的学习路径，您还可以通过 自建插件开发入门课程 进行学习。
5. 基础词汇
1）认识函数
由于函数类型不同，在前端事件中调用函数时，会执行不同的动作。自建插件中支持如下 2 种函数类型：
- 前端扩展：若添加函数为前端扩展，则在前端执行插件时可调用一些前端行为。如弹出地图页面、录音、弹出 iframe 弹窗等；
- 后端函数：若添加函数为后端函数，则后端会完成插件执行的过程。如企业微信群机器人、计算 BMI 等。
2）认识参数
在自建插件中，不同的参数对应不同的插件配置，以便满足用户的多种需求。例如，添加身份验证参数对插件使用者进行身份验证，确保插件调用时的安全等。详情如下：
- 身份验证：指用户在配置插件时需要填写应用的相关信息，从而对插件使用者身份进行验证，保证插件调用时的安全。支持钉钉/企业微信/飞书自建应用、微信公众平台、Basic Auth、OAuth 2.0-Authorization Code 和 OAuth 2.0-Client Credentials 7种身份验证方式；
- 通用参数：指使用插件时要配置的参数，是针对整个插件的参数，在启用插件前对插件的整体配置；
- 请求参数：在不同位置（前端事件、智能助手和流程节点）中使用插件时，插件使用者需要提供的内容；
- 返回参数：插件执行完成后，返回给插件使用者的内容。
3）认识全局变量
在代码设计中，您可以直接引用全局变量来进行代码编辑。简道云支持如下所示 4 种全局变量：
- authConf：插件对应的身份验证参数；
- agentConf：插件对应的通用参数；
- triggerConf：插件函数对应的请求参数；
- triggerContext：存储了运行环境的基本信息，如简道云的开放 API 域名等。
400-111-0890
在线咨询