智简魔方文档

GET 公共配置

接口概览

项目内容
文档类型前台接口
请求方式GET
接口地址/console/v1/common
所属业务公共接口
来源模块/系统公共接口
认证方式无需认证

完整请求

请求

bash
正在加载示例…

失败请求

bash
正在加载示例…

接口说明

公共配置

请求参数

名称位置类型必选说明
accountquerystring否账户

成功响应

json
正在加载示例…

失败响应 400:请求参数或业务校验失败

json
正在加载示例…

失败响应 401:未认证或登录已失效

json
正在加载示例…

失败响应 403:无权执行当前操作

json
正在加载示例…

失败响应 404:接口或业务资源不存在

json
正在加载示例…

失败响应 500:服务器内部错误

json
正在加载示例…

响应状态

状态码状态码含义说明数据模型
200OK成功响应内联对象
400Bad Request请求参数或业务校验失败内联对象
401Unauthorized未认证或登录已失效内联对象
403Forbidden无权执行当前操作内联对象
404Not Found接口或业务资源不存在内联对象
500Internal Server Error服务器内部错误内联对象

响应参数

状态码 200

名称类型必选约束中文名说明
statusinteger(int32)否——状态码
msgstring否——提示信息
dataobject否———
data.lang_list[string | object]否——语言列表
data.lang_list[].display_namestring是———
data.lang_list[].display_flagstring是———
data.lang_list[].display_imgstring是———
data.lang_list[].display_langstring是———
data.lang_homestring否——前台默认语言 zh-cn
data.lang_home_openinteger(int32) | string否——前台多语言开关 1开启 0关闭
data.maintenance_modeinteger(int32) | string否——维护模式开关 1开启 0关闭
data.maintenance_mode_messagestring否——维护模式内容
data.website_namestring否——网站名称
data.website_urlstring否——网站域名地址
data.terms_service_urlstring否——服务条款地址
data.terms_privacy_urlstring否——隐私条款地址
data.prohibit_user_information_changes[string]否——禁止用户信息变更
data.login_phone_verifyinteger(int32) | string否——手机号登录短信验证开关 1开启 0关闭
data.captcha_client_registerinteger(int32)否——客户注册图形验证码开关 1开启 0关闭
data.captcha_client_logininteger(int32)否——客户登录图形验证码开关 1开启 0关闭
data.captcha_client_login_errorinteger(int32)否——客户登录失败图形验证码开关 1开启 0关闭
data.captcha_client_login_error_3_timesinteger(int32)否——客户登录失败3次
data.captcha_client_verifyinteger(int32)否——验证手机邮箱图形验证码开关 1开启 0关闭
data.captcha_client_updateinteger(int32)否——修改手机邮箱图形验证码开关 1开启 0关闭
data.captcha_client_password_resetinteger(int32)否——重置密码图形验证码开关 1开启 0关闭
data.captcha_client_oauthinteger(int32)否——三方登录图形验证码开关 1开启 0关闭
data.captcha_client_security_verifyinteger(int32)否——安全校验是否开启图形验证码 1开启 0关闭
data.register_emailinteger(int32) | string否——邮箱注册开关 1开启 0关闭
data.register_phoneinteger(int32) | string否——手机号注册开关 1开启 0关闭
data.recharge_openinteger(int32) | string否——启用充值 1启用 0否
data.recharge_minnumber(double) | string否——单笔最小金额
data.recharge_maxnumber(double) | string否——单笔最大金额
data.currency_codestring否——货币代码 CNY
data.currency_prefixstring否——货币符号 ¥
data.currency_suffixstring否——货币后缀 元
data.code_client_email_registerinteger(int32) | string否——邮箱注册数字验证码开关 1开启 0关闭
data.system_logostring否——系统LOGO
data.put_on_recordstring否——备案信息
data.enterprise_namestring否——企业名称
data.enterprise_telephonestring否——企业电话
data.enterprise_mailboxstring否——企业邮箱
data.enterprise_qrcodestring否——企业二维码
data.online_customer_service_linkstring否——在线客服链接
data.icp_infostring否——ICP信息
data.icp_info_linkstring否——ICP信息链接
data.public_security_network_preparationstring否——公安网备
data.public_security_network_preparation_linkstring否——公安网备链接
data.telecom_appreciationstring否——电信增值
data.copyright_infostring否——版权信息
data.official_website_logostring否——官网LOGO
data.cloud_product_linkstring否——云产品跳转链接
data.dcim_product_linkstring否——DCIM 产品跳转链接
data.clientarea_logo_urlstring否——会员中心LOGO跳转地址
data.clientarea_logo_url_blankinteger(int32) | string否——会员中心LOGO跳转是否打开新页面 1是 0否
data.feedback_type[object]否——意见反馈类型
data.feedback_type[].idinteger(int32)否——意见反馈类型 ID
data.feedback_type[].namestring否——名称
data.feedback_type[].descriptionstring否——描述
data.friendly_link[object]否——友情链接
data.friendly_link[].idinteger(int32)否——友情链接 ID
data.friendly_link[].namestring否——名称
data.friendly_link[].urlstring否——链接地址
data.honor[object]否——荣誉资质
data.honor[].idinteger(int32)否——荣誉资质 ID
data.honor[].namestring否——名称
data.honor[].imgstring否——图片地址
data.partner[object]否——合作伙伴
data.partner[].idinteger(int32)否——合作伙伴 ID
data.partner[].namestring否——名称
data.partner[].imgstring否——图片地址
data.partner[].descriptionstring否——描述
data.cron_due_renewal_first_swhitchinteger(int32) | string否——是否开启自动续费功能
data.cron_due_renewal_first_dayinteger(int32) | string否——提前多少天续费
data.oauth[object]否——三方登录列表
data.oauth[].imgstring否——图标地址
data.oauth[].namestring否——三方登录标识
data.oauth[].titlestring否——三方登录名称
data.oauth[].urlstring否——请求地址
data.home_enforce_safe_method[string]否——前台强制安全选项 phone=手机 email=邮箱 operate_password=操作密码 certification=实名认证 oauth=三方登录扫码
data.recharge_money_notice_contentstring否——充值金额提示内容
data.recharge_pay_notice_contentstring否——充值支付提示内容
data.first_login_methodstring否——账户凭证首选登录方式 code=验证码 password=密码
data.first_password_login_methodstring否——密码登录首选 phone=手机 email=邮箱
data.cart_instructioninteger(int32)否——购物车说明开关 0关闭 1开启
data.cart_instruction_contentstring否——购物车说明内容
data.cart_change_productinteger(int32)否——购物车切换商品开关 0关闭 1开启
data.plugin_configurationobject否——插件配置
data.plugin_configuration.idcsmart_saleobject否———
data.plugin_configuration.idcsmart_sale.register_hide_saleinteger(int32)否——用户注册时隐藏我有销售 0关闭 1开启
data.login_email_passwordinteger(int32)否——是否开启邮箱密码登录 1开启 0关闭
data.login_phone_passwordinteger(int32)否——是否开启手机密码登录 1开启 0关闭
data.first_login_typestring否——首选登录方式 account_login=账户凭证登录 mp_weixin_notice=微信公众号登录
data.clientarea_theme_display_onestring否——主题区域展示内容1 announcement公告 recommend推荐计划
data.clientarea_theme_displaystring否——主题区域展示内容2 ticket工单 announcement公告 recommend推荐计划
data.clientarea_theme_banner_list[string]否——banner列表
data.donot_save_client_product_passwordinteger(int32)否——不保存用户产品密码 1是 0否
data.lang_home_follow_browserinteger(int32)否——会员中心语言是否跟随浏览器 1是 0否
data.editioninteger(int32)否——版本 1专业版 0基础版
data.code_client_phone_registerstring否———
data.first_navigationstring否———
data.second_navigationstring否———
data.balance_notice_showinteger否———
data.login_register_redirect_showinteger否———
data.login_register_redirect_textstring否———
data.login_register_redirect_urlstring否———
data.login_register_redirect_blankinteger否———
data.clientarea_themestring否———
data.home_themestring否———
data.custom_fields[任意类型]否———
data.clientarea_theme_display_timeinteger否———

失败状态码 400、401、403、404、500 共用以下结构:

名称类型必选约束中文名说明
statusinteger(int32)是——错误状态码
msgstring是——错误提示