Fecify-验证码配置-获取

验证码配置-获取

接口信息

  • 接口地址: {your-site-url}/api/skill/system-setting/captcha-get
  • 基础 URL: {your-site-url} 需替换为你自己的独立站 URL 地址,如 https://your-domain.com/admin
  • 请求方式: GET
  • Content-Type: application/json
  • 配对接口: Fecify-验证码配置-保存
  • 使用流程: 先调用本接口获取当前配置 → 修改各字段 → 调用保存接口提交
  • 说明: 获取验证码全局配置,包括服务端后台登录页、引导端注册/登录/忘记密码等页面的验证码开关及样式设置。

认证

请求头中需要携带 skill-access-token

Header
skill-access-token {your-skill-access-token} (请替换为你自己的 token)

请求参数

无请求参数。

请求示例

cURL

curl --location --request GET '{your-site-url}/api/skill/system-setting/captcha-get' \
--header 'skill-access-token: {your-skill-access-token}' \
--header 'Content-Type: application/json'

返回结果

code200 表示调用成功;code 不为 200 表示调用失败。

成功响应

{
    "code": 200,
    "data": {
        "admin_login": 1,
        "yd_register_account": 2,
        "yd_forgot_password": 2,
        "yd_login_account": 2,
        "length": 4,
        "str_type": 1,
        "expire": 600,
        "bg_color": "random",
        "font_color": "#FFFFFF",
        "vert_color": "random",
        "text_position": "random",
        "text_angle": "rotate"
    },
    "message": "success"
}

返回字段说明

字段 类型 说明
code Number 状态码,200 表示成功
message String 执行结果的文字描述
data Object 返回数据

data 子字段

字段 类型 说明
admin_login Number 服务端后台登录页验证码开关:1 = 开启(显示),2 = 关闭(不显示)
yd_register_account Number 引导端注册页验证码开关:1 = 开启(显示),2 = 关闭(不显示)
yd_forgot_password Number 引导端忘记密码页验证码开关:1 = 开启(显示),2 = 关闭(不显示)
yd_login_account Number 引导端登录页验证码开关:1 = 开启(显示),2 = 关闭(不显示)
length Number 验证码长度,即验证码字符个数
str_type Number 验证码字符类型:1 = 仅数字,2 = 仅字母,3 = 数字和字母混合
expire Number 验证码过期时间,单位:秒
bg_color String 验证码背景色,格式 #FFFFFF;值为 random 时背景色随机
font_color String 验证码字体颜色,格式 #FFFFFF;值为 random 时字体颜色随机
vert_color String 验证码干扰线颜色,格式 #FFFFFF;值为 random 时干扰线颜色随机
text_position String 验证码文本位置:random = 随机,center = 居中
text_angle String 验证码文本旋转:rotate = 旋转,center = 常规(不旋转)

注意事项

  1. 四个验证码开关(admin_loginyd_register_accountyd_forgot_passwordyd_login_account)分别控制不同页面的验证码显示,可独立配置。
  2. 颜色字段(bg_colorfont_colorvert_color)支持十六进制颜色值(如 #FFFFFF)或 random(随机生成)。
  3. 修改配置前先调用本接口获取当前值,编辑后通过 Fecify-验证码配置-保存 提交。

results matching ""

    No results matching ""