跳到主要内容

字段定义

1. 连接器主体结构(API)​

字段名类型必需默认值描述
keystr是-连接器的唯一标识符,用于系统内部识别
labelstr是-连接器显示名称,面向用户的友好名称
descriptionOptional[str]否None连接器的功能描述
imageOptional[str]否None连接器图标URL,用于前端展示
help_urlOptional[str]否None帮助文档链接,指向相关使用说明文档
categoryOptional[str]否None连接器分类,用于归类展示
hiddenbool否False是否隐藏连接器
actionsDict[str, Action]是-包含所有可用操作的字典,键为操作的key,值为操作定义对象
authenticationOptional[Authentication]是-认证配置信息,定义如何进行身份验证
primary_colorOptional[str]否None主颜色
hookOptional[Hook]否None当存在webhook时hook不为空

2. 认证结构 (Authentication)​

字段名类型必需默认值描述
auth_typeAuthTypeLiteral是-认证类型,如 'custom' 表示自定义认证
testCallable是-认证测试函数引用,用于验证认证信息的有效性
fieldsList[Field]是-认证所需字段列表,详细结构查看Field定义
help_textOptional[str]否None帮助文字
config_oauth2Optional[AuthConfigOAuth2]否NoneOAuth2授权配置
config_customOptional[AuthConfigCustom]否None自定义授权配置

3. 操作结构 (Action)​

字段名类型必需默认值描述
keystr是-操作的唯一标识符
implementCallable是-操作实现函数引用
labelstr是-操作显示名称
hiddenbool否False是否隐藏该操作
input_fieldsList[Field]否[]输入字段列表,定义操作所需的参数
output_fieldsList[Field]否[]输出字段列表,定义操作返回的结果参数
dynamic_input_fieldsOptional[List[Field]]否None动态输入字段列表
dynamic_output_fieldsOptional[List[Field]]否None动态输出字段列表
need_verifybool否False是否需要验证
hookOptional[Hook]否None当存在webhook时hook不为空
storagebool否False是否存储额外数据
related_voucherOptional[str]否None关联单据
categoryOptional[str]否None分类

4. 字段结构 (Field)​

字段名类型必需默认值描述
keystr是-参数键名
requiredbool是-是否必需
labelstr是-参数显示名称
help_textOptional[str]否None参数帮助文本
typeFieldTypeLiteral否'str'参数类型,包括 'bool', 'int', 'float', 'str', 'dict', 'list', 'object', 'datetime', 'file' 等
defaultOptional[Any]否None默认值
placeholderOptional[str]否None占位符文本
choicesOptional否None预定义选项,可以是字典 {value: label} 或列表 [value1, value2, ...]
dynamic_choicesOptional[str]否None动态选项,格式为 'action_key.value.label' 的三段式字符串
alters_dynamic_fieldsOptional[bool]否None布尔值,表示该字段更改时是否会影响其他动态字段
childrenOptional[List[Field]]否None子字段列表,当字段类型为 'list' 或 'object' 时使用
widgetOptional[Widget]否None控件定义,用于指定前端显示控件