字段定义

1. 连接器主体结构（API）

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

2. 认证结构 (Authentication)

字段名	类型	必需	默认值	描述
auth_type	AuthTypeLiteral	是	-	认证类型，如 'custom' 表示自定义认证
test	Callable	是	-	认证测试函数引用，用于验证认证信息的有效性
fields	List[Field]	是	-	认证所需字段列表，详细结构查看Field定义
help_text	Optional[str]	否	None	帮助文字
config_oauth2	Optional[AuthConfigOAuth2]	否	None	OAuth2授权配置
config_custom	Optional[AuthConfigCustom]	否	None	自定义授权配置

3. 操作结构 (Action)

字段名	类型	必需	默认值	描述
key	str	是	-	操作的唯一标识符
implement	Callable	是	-	操作实现函数引用
label	str	是	-	操作显示名称
hidden	bool	否	False	是否隐藏该操作
input_fields	List[Field]	否	[]	输入字段列表，定义操作所需的参数
output_fields	List[Field]	否	[]	输出字段列表，定义操作返回的结果参数
dynamic_input_fields	Optional[List[Field]]	否	None	动态输入字段列表
dynamic_output_fields	Optional[List[Field]]	否	None	动态输出字段列表
need_verify	bool	否	False	是否需要验证
hook	Optional[Hook]	否	None	当存在webhook时hook不为空
storage	bool	否	False	是否存储额外数据
related_voucher	Optional[str]	否	None	关联单据
category	Optional[str]	否	None	分类

4. 字段结构 (Field)

字段名	类型	必需	默认值	描述
key	str	是	-	参数键名
required	bool	是	-	是否必需
label	str	是	-	参数显示名称
help_text	Optional[str]	否	None	参数帮助文本
type	FieldTypeLiteral	否	'str'	参数类型，包括 'bool', 'int', 'float', 'str', 'dict', 'list', 'object', 'datetime', 'file' 等
default	Optional[Any]	否	None	默认值
placeholder	Optional[str]	否	None	占位符文本
choices	Optional	否	None	预定义选项，可以是字典 {value: label} 或列表 [value1, value2, ...]
dynamic_choices	Optional[str]	否	None	动态选项，格式为 'action_key.value.label' 的三段式字符串
alters_dynamic_fields	Optional[bool]	否	None	布尔值，表示该字段更改时是否会影响其他动态字段
children	Optional[List[Field]]	否	None	子字段列表，当字段类型为 'list' 或 'object' 时使用
widget	Optional[Widget]	否	None	控件定义，用于指定前端显示控件