连接器

概述

连接器（Connector）模块用于配置第三方登录和消息通知服务。通过连接器，平台可以集成社交登录（如微信、GitHub）、邮件验证码和短信验证码等功能，为用户提供多样化的登录和注册方式。

导航路径: 侧边栏 -> 连接器

连接器类型

类型	说明	用途
email	邮件连接器	发送邮件验证码，用于邮箱注册、登录和密码重置
sms	短信连接器	发送短信验证码，用于手机号注册、登录和密码重置
social	社交登录连接器	集成第三方社交平台登录（如微信、GitHub、Google 等）

连接器列表

连接器列表页面展示所有已配置的连接器。

列表字段

字段	说明
名称	连接器的显示名称
连接器 ID	连接器的唯一标识（如 aliyun-email、twilio-sms）
类型	email / sms / social
描述	连接器的简要说明
Logo	连接器的图标
启用状态	是否已启用
创建时间	连接器创建时间

筛选条件

• 类型 (type): 按连接器类型筛选（email / sms / social）
• 连接器 ID (connector_id): 按连接器标识筛选

创建连接器

点击 "新建连接器" 按钮进入创建页面。

导航路径: 连接器 -> 新建连接器

创建参数

字段	必填	说明
connector_id	是	连接器的唯一标识（标识连接器的实现类型）
config	是	连接器的配置信息（JSON 格式，具体字段因连接器类型而异）

API 调用:

POST /api/v1/connectors

请求示例（邮件连接器）：

{
  "connector_id": "aliyun-direct-mail",
  "config": {
    "access_key_id": "your_access_key_id",
    "access_key_secret": "your_access_key_secret",
    "account_name": "noreply@example.com",
    "region": "cn-hangzhou"
  }
}

请求示例（短信连接器）：

{
  "connector_id": "aliyun-sms",
  "config": {
    "access_key_id": "your_access_key_id",
    "access_key_secret": "your_access_key_secret",
    "sign_name": "你的短信签名",
    "template_code": "SMS_123456789"
  }
}

请求示例（社交登录连接器）：

{
  "connector_id": "wechat-native",
  "config": {
    "app_id": "your_wechat_app_id",
    "app_secret": "your_wechat_app_secret"
  }
}

编辑连接器

在连接器列表中点击连接器名称或编辑按钮，进入编辑页面。

导航路径: 连接器 -> 编辑连接器

可编辑字段

字段	说明
配置	修改连接器的配置信息
启用状态	启用或禁用连接器

API 调用:

PATCH /api/v1/connectors/:id

请求示例：

{
  "config": {
    "access_key_id": "new_access_key_id",
    "access_key_secret": "new_access_key_secret"
  },
  "enabled": true
}

测试连接器

创建或修改连接器配置后，建议先进行测试以验证配置是否正确。

操作方式: 在连接器编辑页面点击 "测试" 按钮。

API 调用:

POST /api/v1/connectors/:id/test

响应示例：

{
  "success": true,
  "message": "连接器配置验证通过"
}

如果测试失败，响应会包含错误信息，请根据提示调整配置。

删除连接器

删除连接器将移除其所有配置。此操作不可逆。

API 调用:

DELETE /api/v1/connectors/:id

注意: 删除正在使用的连接器会导致对应的登录方式或验证码发送功能不可用。请确保在删除前已从登录体验配置中移除对该连接器的依赖。

连接器与登录体验的关系

连接器配置好并启用后，还需要在"登录体验"模块中配置对应的登录方式才能生效：

1. 配置并启用邮件连接器后，在登录体验中可以启用 "邮箱 + 验证码" 登录方式
2. 配置并启用短信连接器后，在登录体验中可以启用 "手机号 + 验证码" 登录方式
3. 配置并启用社交登录连接器后，登录页面会展示对应的社交登录按钮

安全建议

• 连接器配置中的密钥信息（如 Access Key Secret、App Secret 等）请妥善保管
• 定期轮换连接器使用的密钥
• 仅启用实际需要的连接器，减少攻击面
• 创建连接器后务必进行测试验证